forked from simonmichael/hledger
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
;doc: separate CHANGELOGS, COMMITS docs
- Loading branch information
1 parent
479b0d2
commit fd052d3
Showing
3 changed files
with
143 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Changelogs | ||
|
||
Always maintain changelogs in master branch (not in release branches). | ||
|
||
**Frequently**, especially after merging changes, and before cherry picking into release branch: | ||
|
||
- dry run: `./Shake changelogs -n` | ||
- add new changes: `./Shake changelogs` | ||
- edit | ||
- drop things | ||
- move things | ||
- Add headings: Features, Improved, Fixes | ||
- rewrite things | ||
- format ([#ISSUE](https://github.com/simonmichael/hledger/issues/), AUTHOR) on its own line | ||
- commit: `./Shake changelogs -c` | ||
|
||
**After cherry-picking** changes to a release branch: | ||
- in the master branch changelogs, move the corresponding changelog items under a pending release heading, | ||
creating that when necessary: | ||
``` | ||
# LATESTHASH | ||
...CHANGES ONLY IN MASTER... | ||
# NEXTVER unreleased | ||
...CHANGES CHERRYPICKED INTO RELEASE BRANCH... | ||
# LASTVER YYYY-MM-DD | ||
``` | ||
**At release:** | ||
- do final update/edits; check organisation, wording, formatting, issue links | ||
- replace "unreleased" with the release date | ||
- copy the new sections from master changelogs to release branch changelogs | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# COMMITS | ||
|
||
## When committing / reviewing commits | ||
|
||
Follow/encourage the [commit conventions](CONTRIBUTING.html#commit-messages). | ||
Here they are in brief: | ||
- Commit messages must begin with a prefix, one or more colon-terminated words | ||
indicating the [topic](CONTRIBUTING.html#topics). | ||
- Commits causing user-visible changes must additionally begin with `feat:`, `imp:` or `fix:` | ||
(feature, improvement, or bugfix). These will be mentioned in release notes. | ||
- Add a leading `;` to commits where a CI build is not needed, to reduce waste. | ||
- Add a `!` to highlight commits causing breaking/incompatible changes. | ||
- Mention any relevant issue numbers, usually parenthesised at the end. `(#NNNN)` | ||
- Try to write commit messages as changelog-ready documentation that will tell their | ||
intended audience (which might be users, installers, packagers, and/or developers) | ||
what they need to know. | ||
|
||
## When committing/pushing/merging: | ||
- run `bin/commitlint` before push, to check recent commits | ||
- or, run it automatically before each commit (`make installcommithook` to configure your local repo) | ||
- it also runs in CI on github for pull requests, etc. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters