This is an incomplete list of things to take care while contributing.
- Don't touch files or pieces non-related to the commit message, create a different commit instead.
- Keep the commits simple to make the reviews easy.
- Merge commits will be rejected, use rebase instead, run
git config pull.rebase trueafter cloning the repository to rebase automatically. - Every commit should have working code with all tests passing.
- Every commit should include tests unless it is not practical.
- We use scalafmt to format the code automatically, follow the IntelliJ setup for scalafmt.
- The pull requests should go to the
masterbranch. - Make sure to test the native builds to avoid this issue.
It is simpler to use the recommended developer environment.
- IntelliJ with the Scala plugin, configured to format-on-save.