@@ -1,13 +1,23 @@
11# Contributing
22
3−### Add an entry to the changelog
3+Thank you for considering to contribute to `bat`!
44
5−Please don't forget to update [CHANGELOG.md](CHANGELOG.md) and describe your changes (in the "unreleased" section), this makes the release of a new `bat` version much easier.
65
7−Each entry should follow the following format:
6+
7+## Add an entry to the changelog
8+
9+If your contribution changes the behavior of `bat` (as opposed to a typo-fix
10+in the documentation), please update the [`CHANGELOG.md`](CHANGELOG.md) file
11+and describe your changes. This makes the release proess much easier and
12+therefore helps to get your changes into a new `bat` release faster.
13+
14+The top of the `CHANGELOG` contains a *"unreleased"* section with a few
15+subsections (Features, Bugfixes, …). Please add your entry to the subsection
16+that best describes your change
17+
18+Entries follow this format:
819```
920- Short description of what has been changed, see #123 (@user)
1021```
11−
12−Where `#123` is your PR's number or ticket and `@user` is you Github's username.
13−
22+Here, `#123` is the number of the original issue and/or your pull request.
23+Please replace `@user` by your GitHub username.