diff options
author | sharkdp <davidpeter@web.de> | 2020-10-29 19:46:36 +0100 |
---|---|---|
committer | David Peter <sharkdp@users.noreply.github.com> | 2020-10-29 20:16:33 +0100 |
commit | 2889e017cd05c02628ed47f253d210de832942cc (patch) | |
tree | b5d8f5d6852b4ec77d3e2334d76de50c423286ca /CONTRIBUTING.md | |
parent | 47ea99090f3d817d4a677195b7d2dcb86e7e831e (diff) |
More detailed description for CHANGELOG section
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ccaf528a..8e943eb0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,23 @@ # Contributing -### Add an entry to the changelog +Thank you for considering to contribute to `bat`! -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. -Each entry should follow the following format: + +## Add an entry to the changelog + +If your contribution changes the behavior of `bat` (as opposed to a typo-fix +in the documentation), please update the [`CHANGELOG.md`](CHANGELOG.md) file +and describe your changes. This makes the release proess much easier and +therefore helps to get your changes into a new `bat` release faster. + +The top of the `CHANGELOG` contains a *"unreleased"* section with a few +subsections (Features, Bugfixes, …). Please add your entry to the subsection +that best describes your change + +Entries follow this format: ``` - Short description of what has been changed, see #123 (@user) ``` - -Where `#123` is your PR's number or ticket and `@user` is you Github's username. - +Here, `#123` is the number of the original issue and/or your pull request. +Please replace `@user` by your GitHub username. |