diff options
Diffstat (limited to 'doc/contribute.md')
| -rw-r--r-- | doc/contribute.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/contribute.md b/doc/contribute.md index 49792583..d3b33aa7 100644 --- a/doc/contribute.md +++ b/doc/contribute.md @@ -45,3 +45,17 @@ for what maintainers will look at in PRs. - Commits that fix mistakes from previous commits must be squashed - Conflicts must be resolved by rebasing, instead of merging + +### Commit format + +The preferred format for commits is the following: + +``` +module: Short description + +A more thorough description of all changes in this commit if necessary. +``` + +where module can be the name of the file, +with or without extension, +or a single word explaining the scope of the changes. |