InfiniTimeOrg/InfiniTime
1
1
Fork 0
mirror of https://github.com/InfiniTimeOrg/InfiniTime.git synced 2024-12-24 18:22:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

contribute.md: Add commit format section

Browse Source 
Inspired by:
https://www.klipper3d.org/CONTRIBUTING.html#format-of-commit-messages
This commit is contained in:
Riku Isokoski 2023-01-29 18:19:43 +02:00
parent f9d03cc396
commit 4e1a2aff47
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/contribute.md
View File

@ -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.