Skip to content

Commit eb6accf

Browse files
committed
;doc: contrib: commit conventions update
1 parent 7d6dc7f commit eb6accf

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -510,12 +510,10 @@ Relevant tools include:
510510
## Commit messages
511511

512512
Starting with the 1.23 release cycle, I'm proposing some new
513-
conventions for commit messages (WIP, will evolve as needed),
514-
aiming to:
513+
conventions for commit messages (WIP, will evolve as needed), aiming to
515514

516-
- reduce the cost of maintaining change docs (changelogs, release notes, announcements)
517-
- reduce the cost of releases
518515
- encourage considered, focussed, well documented changes
516+
- reduce the cost of code review, maintaining changelogs and release notes, and releasing
519517
- increase our throughput (rate of shipping useful, reliable, documented, maintainable features)
520518

521519
**hledger commit conventions:**
@@ -570,13 +568,15 @@ aiming to:
570568
the end of the summary: `(#NNNN)`.
571569

572570
7. The summary, and description if any, communicate this change's
573-
purpose as clearly as possible to its target audience: end users,
574-
builders/packagers/library users, developers/debuggers. The text
575-
should be ready for use in changelogs/release notes when applicable.
576-
577-
Crafting good commit messages (and thereby, good commits, and good
578-
change documentation) is an art and a habit; we'll check and satisfy
579-
these conventions as part of CI and code review.
571+
purpose as clearly as possible to its intended audience:
572+
end users, builders/packagers/library users, or developers/debuggers.
573+
The text (or its first sentence/first paragraphs) should be ready
574+
for use in changelogs/release notes when applicable.
575+
576+
Crafting good commit messages (and thereby good commits, good change
577+
documentation, easier code review, faster merging) is an art and a
578+
habit; we'll check and satisfy these conventions as part of CI and
579+
code review.
580580

581581
Related:
582582

0 commit comments

Comments
 (0)