First of all, thank you for contributing!
Here are a few rules to follow in order to ease code reviews and merging:
- follow the coding style and conventions
- 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 and add the related issue.