diff options
| -rw-r--r-- | CONTRIBUTING.md (renamed from CONTRIBUTORS.md) | 8 | ||||
| -rw-r--r-- | README.md | 4 |
2 files changed, 7 insertions, 5 deletions
diff --git a/CONTRIBUTORS.md b/CONTRIBUTING.md index 7690f7d2..ccaf528a 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTING.md @@ -1,11 +1,13 @@ -# Contributors +# Contributing -## Add an entry to the changelog +### Add an entry to the changelog 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: +``` - Short description of what has been changed, see #123 (@user) +``` -Where #123 links to the PR and @user is you Github's username. +Where `#123` is your PR's number or ticket and `@user` is you Github's username. @@ -676,9 +676,9 @@ bash assets/create.sh cargo install --path . --locked --force ``` -## Contributors +## Contributing -Take a look to this [guide](CONTRIBUTORS.md) +Take a look to this [guide](CONTRIBUTING.md) ## Maintainers |