First of all, thank you for contributing!
Please note we have a code of conduct, please follow it in all your interactions with the project.
When you open a Pull Request, you agree to license your code under a proprietary license and to transfer the copyright on the submitted code to the owner of this project.
Be sure to you have the right to do that (if you are a professional, ask your company)!
If you include code from another project, please mention it in the Pull Request description and credit the original author.
If you happen to find a bug, we kindly request you to report it. However, before submitting it, please:
- Check the documentation,
- Check if the bugs is not already reported,
- Give a clear title to resume the issue,
- Give a description of the usage and steps needed to reproduce the bug.
Here are a few rules to follow in order to ease code reviews and merging:
- Run the test suite,
- Write (or update) unit tests when applicable,
- Write documentation for new features,
- Use commit messages that make sense.
One may ask you to squash your commits too.
This is used to "clean" your pull request before merging it (we don't want commits such as fix tests, fix 2, fix 3, etc.).
When creating your pull request on GitHub, please write a description which gives the context and/or explains why you are creating it.