This page lists criteria that code, commits and pull requests should fulfill.
- Commit messages should have a short message and a description. The description should explain: (a) What's changed. (b) What problem is fixed or what feature does work now (c) What alternative solutions were discarded and why.
- Commit messages should refer to the Github Issue, if there is one you can do so by prefixing your commit title by
[#issueTicketNr]e.g.[#123]. - Pull Requests must have a cleaned-up sequence of commits. Do not put unrelated changes in the same commit. Squash commits if they contribute to the same logical change.
- Commits must be reviewable by a human. Do not re-format code that's otherwise not changed. Make sure commits don't become too large.
- Avoid putting generated source code and hand-written source code in the same commit, except for small changes.
- Changes must have unit tests.
- Good changes are the ones that do not cause, or even minimize future effort, e.g. bugfixes and follow-up feature requests.
- Readable and understandable source code is good source code.
- Keep the source code well-formatted, use the provided formatter .
- Put high-level comments in the code to explain your intention, solved use cases, design decisions, rejected solutions, etc. Do not duplicate what is obvious from the code itself. People will read code + documentation, therefore documentation does not need to be self-contained.