From 47ea99090f3d817d4a677195b7d2dcb86e7e831e Mon Sep 17 00:00:00 2001 From: Adrian Rivera Date: Tue, 27 Oct 2020 21:39:54 -0700 Subject: [PATCH] Style changes on CONTRIBUTORS --- CONTRIBUTORS.md => CONTRIBUTING.md | 8 +++++--- README.md | 4 ++-- 2 files changed, 7 insertions(+), 5 deletions(-) rename CONTRIBUTORS.md => CONTRIBUTING.md (67%) diff --git a/CONTRIBUTORS.md b/CONTRIBUTING.md similarity index 67% rename from CONTRIBUTORS.md rename to 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. diff --git a/README.md b/README.md index 6f2a2b67..6b5e01ed 100644 --- a/README.md +++ b/README.md @@ -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