slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: contrib: commit message conventions

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-07-15 17:40:56 +01:00
parent e560afccd2
commit 2ed51685b9
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -619,6 +619,12 @@ so think about future developers trying to understand them, git bisect, etc.
Rebase your commits against latest master for easiest review. Especially if they start to conflict. Rebase your commits against latest master for easiest review. Especially if they start to conflict.
Some conventions we often use in commit messages:
- prepend a [component](#components) prefix, eg `cli: ` or `journal: `, for clarity and to help with changelog production
- prepend a semicolon (`;`) to indicate boring commits that won't affect changelogs/release notes (as in the Emacs project)
- add a final `[ci skip]` line for commits which probably don't need to trigger a CI build, to reduce carbon emissions from Travis
### The docs ### The docs
PRs should include appropriate updates to reference documentation, unless otherwise agreed. PRs should include appropriate updates to reference documentation, unless otherwise agreed.