Contribute

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. Before committing, unit tests and jshint (IntelliJ code style warnings) should be passed successfully.
4. Once you have finished your work, open a pull request. This opens your work for discussion and testing.
5. A different developer should merge this pull request back onto the master branch. This makes sure there was a quick code review and testing.
6. After merging delete your feature branch and make sure the corresponding issue(s) and pull request are closed.

Tips for development

• Reference the issue or pull request you are working on in your 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.
• The Angular Style Guide provides helpful principles for AngularJS development.