diff options
| author | Riku Isokoski <riksu9000@gmail.com> | 2023-01-29 18:19:43 +0200 |
|---|---|---|
| committer | Riku Isokoski <riksu9000@gmail.com> | 2023-02-12 14:36:04 +0200 |
| commit | 4e1a2aff47063c233fa0244d052d72fc4febc9d1 (patch) | |
| tree | d60f8aca309b3cc8bbbbfa66ef0bec44add04cb5 | |
| parent | f9d03cc39624853f43a15843f7ce3cea4d2e2451 (diff) | |
contribute.md: Add commit format section
Inspired by:
https://www.klipper3d.org/CONTRIBUTING.html#format-of-commit-messages
| -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. |