diff options
| author | Robin Jarry <robin@jarry.cc> | 2022-07-12 12:40:07 +0200 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2022-07-26 23:28:43 +0200 |
| commit | 45e6e89b2440575a24d912250aaeb5391f640593 (patch) | |
| tree | d4db76cc0656de7e3f8555ee1230ee9bcba33f03 /README.md | |
| parent | ea718fe146fa21f6899179a17e218a670b832ee8 (diff) | |
| download | aerc-45e6e89b2440575a24d912250aaeb5391f640593.tar.gz | |
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 <robin@jarry.cc>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 6 insertions, 0 deletions
@@ -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). |