From 45e6e89b2440575a24d912250aaeb5391f640593 Mon Sep 17 00:00:00 2001 From: Robin Jarry Date: Tue, 12 Jul 2022 12:40:07 +0200 Subject: Add changelog Git history is not for everyone. Let's introduce a user-oriented change log. Ideally, this file should be updated incrementally when adding a new feature. I have added contributors guidelines in README.md. Update release.sh to automatically generate the release tag message with the unreleased changes from the changelog. Link: https://keepachangelog.com/en/1.0.0/ Signed-off-by: Robin Jarry --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 06db9660..12aa6acc 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,10 @@ you did not break anything. - If applicable, update unit tests. - If adding a new feature, please consider adding new tests. - Do not forget to update the docs. +- If your commit brings visible changes for end-users, add an entry in the + *Unreleased* section of the + [CHANGELOG.md](https://git.sr.ht/~rjarry/aerc/tree/master/item/CHANGELOG.md) + file. Once you are happy with your work, you can create a commit (or several commits). Follow these general rules: @@ -199,3 +203,5 @@ Submit *confirmed* bug reports and *confirmed* feature requests on [https://todo.sr.ht/~rjarry/aerc](https://todo.sr.ht/~rjarry/aerc). [License](https://git.sr.ht/~rjarry/aerc/tree/master/item/LICENSE). + +[Change log](https://git.sr.ht/~rjarry/aerc/tree/master/item/CHANGELOG.md). -- cgit