Contributing

Reporting issues

We use Github issues to track bug reports, feature requests, and submitting pull requests.

If you find a bug:

Use the GitHub issue search to check whether the bug has already been reported.
If the issue has been fixed, try to reproduce the issue using the latest master branch of the repository.
If the issue still reproduces or has not yet been reported, try to isolate the problem before opening an issue.

If you want to contribute to this project and make it better, your help is very welcome!

How to make a clean pull request

Clone this repository.
Create a branche from Master using the following format [to do].
Make your contribution.
Comment your code accordingly.
Follow the coding guidelines defined in the README file.
Run the test to make sure nothing is broken.
Write new tests, or adapt tests as needed.
Write new documentation, or adapt documentation as needed.
Squash your commits into a single commit and push it.
Open a new Pull Request based on Master, following the template already in place.

Once your pull request is approved and merged you will be able to pull the changes from upstream to your local repo and delete your extra branch(es).