From 9bc88727511ac8d1a83f12cc39aecb59d8869206 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 26 Jan 2019 07:44:39 -0800 Subject: [PATCH] doc: contributing: changelog process [ci skip] --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36129430d..b6e95be01 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1245,10 +1245,11 @@ Draft: Changelogs: -- choose release version and date -- add new sections at top of {doc,hledger*}/CHANGES -- move the items from CHANGES.draft.org to these CHANGES files -- remove CHANGES.draft.org +- `CHANGES.md` in each package directory, and one in the top directory (project-wide changes, perhaps just for staging) +- markdown format: - bullets, indented literal blocks +- there's always a heading at the top whose first word is a release version or (between releases) a commit hash +- `make changelogs` to add any new commits to the top of all changelogs +- then clean those up manually: identify, filter, move to correct changelog, deduplicate, rewrite, sort/group Release notes: