We highly welcome and encourage all users to contribute improvements to help increase the quality of the documentation and the code. We want to keep it simple and easy for you to help. There are a few guidelines we would like you to follow.
You can contribute in two ways:
- Contribute changes with pull request
- File an issue to report bugs, questions and feature requests
If you have suggestions on how to fix or change things, do make the changes and open pull requests.
- Read the notice for contribution carefully
- Make sure you have a GitHub account.
- Submit an issue if one does not exist already. See File an issue for details.
- If you are contributing a pull request that fixes an issue, please reference the issue in your pull request.
Below is the workflow, from cloning to merging a pull request.
- Fork this repository
- Clone
- Create your own branch to make changes
- Keep your fork up-to-date/synced with the remote repository
- Commit your changes
- Push changes back to the remote on GitHub
- Create pull request to "develop" branch
- If you get feedback, fix according to comments/discussion and push a new commit
- When the review is done and accepted it will be squashed and merged into master by the maintainers
If you found a bug and do not how to solve it, please use the GitHub issue tracker.
You can also file an issue if you have suggestions for new features or questions about the descriptions and functionalities.
For troubleshooting efficiency provide as much information about your setup conditions.
Use this template when reporting a bug:
Description of the issue:
How to reproduce:
Describe your hardware setup:
Software version used:
And tag the issue with the label bug