Skip to content

Instantly share code, notes, and snippets.

@heinrichreimer

heinrichreimer/CONTRIBUTION_TEMPLATE.md

Last active March 30, 2017 02:04
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save heinrichreimer/bb3be5378d7ed689216828efaf652830 to your computer and use it in GitHub Desktop.
Save heinrichreimer/bb3be5378d7ed689216828efaf652830 to your computer and use it in GitHub Desktop.
Download ZIP
This contribution guidelines provide useful information and basic rules for contributing to Heinrich Reimer Software open source projects.
Raw
CONTRIBUTION_TEMPLATE.md

Contributing Guidelines

We'd love for you to contribute to and to make them even better! Here are the guidelines we'd like you to follow:

Code of Conduct

Help us keep <COMPANY_NAME> projects open and inclusive. Please read and follow our Code of Conduct.

Got a Question or Problem?

If you have questions about how to use any project, please direct these to the GitHub Issues page or StackOverflow. You can also use our contact form.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix.

Please see the Submission Guidelines below.

Want a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Changes can be crafted and submitted to the GitHub Repository as a Pull Request.

Want a Doc Fix?

If you want to help improve the docs, it's a good idea to let others know what you're working on to minimize duplication of effort. Create a new issue (or comment on a related existing one) to let others know what you're working on.

For large fixes, please build and test the documentation before submitting the PR to be sure you haven't accidentally introduced any layout or formatting issues. You should also make sure that your commit message starts with "docs" and follows the Commit Message Guidelines outlined below.

If you're just making a small change, don't worry about filing an issue first. When naming the commit, it is advised to follow the commit message guidelines below, by starting the commit message with docs and referencing the filename. Since this is not obvious and some changes are made on the fly, this is not strictly necessary and we will understand if this isn't done the first few times.

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - If an error is being thrown a non-minified stack trace helps
  • Motivation for or Use Case - Explain why this is a bug for you
  • Version(s) - Is it a regression?
  • Browsers and/or Operating System - Is this a problem with all browsers/OS or only specific ones?
  • Reproduce the Error - Provide a live example or an unambiguous set of steps.
  • Related Issues - Has a similar issue been reported before?
  • Suggest a Fix - If you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

If you get help, help others. Good karma rulez!

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

  • Search for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

  • Please sign our Contributor License Agreement (CLA) before sending pull requests. We cannot accept code without this.

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  • Create your patch, including appropriate test cases.

  • Follow our Coding Rules.

  • Run the full test suite (if existent) and ensure that all tests pass.

  • Commit your changes using a descriptive commit message that follows our commit message conventions and passes our commit message presubmit hook. Adherence to the commit message conventions is required, because release notes may be automatically generated from these messages in some of our repositories.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Build your changes locally to ensure all the tests pass.

  • Push your branch to GitHub:

    git push origin my-fix-branch

In GitHub, send a pull request. If we suggest changes, then:

  • Make the required updates.
  • Re-run the test suite to ensure tests are still passing.
  • Commit your changes to your branch (e.g. my-fix-branch).
  • Push the changes to your GitHub repository (this will update your Pull Request).

If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git rebase master -i
git push origin my-fix-branch -f

WARNING: Squashing or reverting commits and force-pushing thereafter may remove GitHub comments on code that were previously made by you or others in your commits. Avoid any form of rebasing unless necessary.

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs/unit tests.
  • All public API methods must be documented. To see how we document our APIs, please check out the existing source code.
  • We follow the rules contained in Google's Code Style Guide

Git Commit Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we may use the git commit messages to generate change logs.

The commit message formatting can be added using a typical git workflow through the use of a CLI wizard (Commitizen).

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Scope

The scope could be anything specifying place of the commit change. This could be a package or something similar.

You can use * when the change affects more than a single scope.

Subject

The subject contains succinct description of the change:

  • Use the imperative, present tense: "change" not "changed" nor "changes"
  • Capitalize first letter
  • No dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Signing the CLA

Please sign our Contributor License Agreement (CLA) after sending pull requests. For any code changes to be accepted, the CLA must be signed. It's a quick, automated process, we promise! Watch for messages from our CLA bots.

(This guidelines are modified from AngularJS' contributing guidelines and licensed under the MIT License.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment