mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-19 10:17:35 +03:00
doc: commits: tweak
This commit is contained in:
parent
bf9e019bcb
commit
9c3ee3ada4
19
COMMITS.md
19
COMMITS.md
@ -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.
|
||||
(You can also set up a local commit hook, described below.)
|
||||
|
||||
<!-- keep synced with tools/commitlint -->
|
||||
Here's the typical format:
|
||||
Here's the typical format: <!-- keep synced with tools/commitlint -->
|
||||
|
||||
[feat|imp|fix[!]:] topic: Summary
|
||||
|
||||
[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:
|
||||
|
||||
- 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)
|
||||
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:
|
||||
|
||||
- `feat` - a new feature
|
||||
|
Loading…
Reference in New Issue
Block a user