This repository has been archived by the owner on Apr 6, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing
Santiago Garcia Gil edited this page Nov 18, 2020
·
1 revision
Which branch:
- Make your pull request target master.
- At least one commit message in the PR starts with Fixes #id : where id is an issue tracker id. This allows automated release notes generation. Also GitHub will track the issue and close it when the PR is merged.
- Include tests
- For new features consider adding new documentation item in Readme file
- Also, look at the GitHub's Pull Request guide
- Comment on issues or pull requests.
- Please suggest changes to documentation when you find something unclear.
- You can create a fork of this project in no time. Go to the github project and "Create your own fork". Create a new branch, commit, ..., when you're ready let us know about your pull request so we can discuss it and merge the PR!
- On pull requests, please document the change, what it brings, what is the benefit.
- Clean commit history in the topic branch in your fork of the repository, even during review. That means that commits are rebased and squashed if necessary, so that each commit clearly changes one things and there are no extraneous fix-ups.
Example:
Feature #73 : The new feature
Fixes #74 : Refactor unit tests
- In the code, always test your feature / change, in unit tests.