bat/CONTRIBUTING.md

14 lines
429 B
Markdown
Raw Normal View History

2020-10-28 05:39:54 +01:00
# Contributing
2020-10-28 05:35:35 +01:00
2020-10-28 05:39:54 +01:00
### Add an entry to the changelog
2020-10-28 05:35:35 +01:00
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:
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
```
2020-10-28 05:35:35 +01:00
2020-10-28 05:39:54 +01:00
Where `#123` is your PR's number or ticket and `@user` is you Github's username.
2020-10-28 05:35:35 +01:00