Author: Riku Isokoski <riksu9000@gmail.com>
contribute.md: Add commit format section Inspired by: https://www.klipper3d.org/CONTRIBUTING.html#format-of-commit-messages
doc/contribute.md | 14 ++++++++++++++
diff --git a/doc/contribute.md b/doc/contribute.md index 497925835073186acfb2b38970a8029b7d4665e6..d3b33aa75dca9635ef6ce7c1c3a2c38f8c264ab7 100644 --- a/doc/contribute.md +++ b/doc/contribute.md @@ -45,3 +45,17 @@ that sufficiently explains all the changes in the commit - 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.