contribute.md: Add commit format section
Inspired by: https://www.klipper3d.org/CONTRIBUTING.html#format-of-commit-messages
This commit is contained in:
parent
f9d03cc396
commit
4e1a2aff47
|
@ -45,3 +45,17 @@ for what maintainers will look at in PRs.
|
||||||
- Commits that fix mistakes from previous commits must be squashed
|
- Commits that fix mistakes from previous commits must be squashed
|
||||||
- Conflicts must be resolved by rebasing,
|
- Conflicts must be resolved by rebasing,
|
||||||
instead of merging
|
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.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user