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

doc: commits: tweak

Browse Source
This commit is contained in:
Simon Michael 2022-02-07 12:02:30 -10:00
parent bf9e019bcb
commit 9c3ee3ada4
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
COMMITS.md
View File

@ -10,21 +10,12 @@ easier code review => quicker merging => faster delivery of quality software.
We'll check and help you polish messages as part of CI and code review. We'll check and help you polish messages as part of CI and code review.
(You can also set up a local commit hook, described below.) (You can also set up a local commit hook, described below.)
<!-- keep synced with tools/commitlint --> Here's the typical format: <!-- keep synced with tools/commitlint -->
Here's the typical format:
[feat|imp|fix[!]:] topic: Summary [feat|imp|fix[!]:] topic: Summary
[Longer description when useful] [Longer description when useful]
Some examples:
- *feat: accounts: --types shows account types (#1820)*
- *imp!: journal: Remove deprecated account type code syntax from account directives.*
- *fix: types: Ensure auto postings can match against and be matched by type: queries.*
- *tools: commitlint: allow a git "fixup! " prefix*
- *doc: releasing: tweaks*
More precisely: More precisely:
- Commit messages must begin with one or more prefixes (colon-terminated words), - Commit messages must begin with one or more prefixes (colon-terminated words),
@ -40,6 +31,14 @@ More precisely:
intended audience (which might be users, installers, packagers, and/or developers) intended audience (which might be users, installers, packagers, and/or developers)
what they need to know. what they need to know.
Some examples:
- `feat: accounts: --types shows account types (#1820)`
- `imp!: journal: Remove deprecated account type code syntax from account directives.`
- `fix: types: Ensure auto postings can match against and be matched by type: queries.`
- `tools: commitlint: allow a git "fixup! " prefix`
- `doc: releasing: tweaks`
Some possible prefixes: Some possible prefixes:
- `feat` - a new feature - `feat` - a new feature