Skip to content
This repository has been archived by the owner on May 17, 2021. It is now read-only.

Contribute

Jump to bottom
Frederik Schöll edited this page Dec 9, 2015 · 4 revisions

Guidelines for Contributors

The GitHub Flow

As for now, we are following the GitHub Flow for development. In summary, this means each feature will be implemented on it's own branch, which will then merged back onto the master branch. If you participate in the development, either by fixing a bug or implementing a new feature, follow these steps:

  1. Create a new branch.
  2. Commit onto this branch while you are developing. Please don't use the same branch for implementing multiple features or independent bug fixes, but rather create multiple, distinct branches if necessary.
  3. Once you have finished your work, open a pull request. This opens your work for discussion and testing.
  4. If your work has passed the unit tests and jshint successfully, you may merge it back onto the master branch.
  5. After the work is done, delete your feature branch and make sure the corresponding issue and pull request are closed.

Tips for development

  • Reference the issue or pull request you are working on in your commits (at least for non-trivial commits).
  • If you have a lot of trivial commits in your working feature branch (such as fixed typos, fixed codestyle warnings, ...) you may squash some commits for better readability of the git history. This can be done with a git rebase on your feature branch (please never rebase the master branch). Further information can be found in the Git Book.
Clone this wiki locally