bat/CONTRIBUTING.md

24 lines
806 B
Markdown
Raw Normal View History

2020-10-28 05:39:54 +01:00
# Contributing
2020-10-28 05:35:35 +01:00
Thank you for considering to contribute to `bat`!
2020-10-28 05:35:35 +01:00
## 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:
2020-10-28 05:39:54 +01:00
```
2020-10-28 05:35:35 +01:00
- Short description of what has been changed, see #123 (@user)
2020-10-28 05:39:54 +01:00
```
Here, `#123` is the number of the original issue and/or your pull request.
Please replace `@user` by your GitHub username.