More detailed description for CHANGELOG section

This commit is contained in:
sharkdp 2020-10-29 19:46:36 +01:00 committed by David Peter
parent 47ea99090f
commit 2889e017cd
2 changed files with 17 additions and 7 deletions

View File

@ -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.

View File

@ -678,7 +678,7 @@ cargo install --path . --locked --force
## Contributing
Take a look to this [guide](CONTRIBUTING.md)
Take a look at the [`CONTRIBUTING.md`](CONTRIBUTING.md) guide.
## Maintainers