diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 00000000..7690f7d2 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,11 @@ +# Contributors + +## 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. + diff --git a/README.md b/README.md index 9357a30c..6f2a2b67 100644 --- a/README.md +++ b/README.md @@ -678,19 +678,7 @@ cargo install --path . --locked --force ## Contributors -Please don't forget to update `CHANGELOG.md` and describe your changes, this makes the release of a new `bat` version much easier. - -Each entry should follow the next format: -- Short description of the change (one line) -- Number of the pull request -- Github's username - -See the next examples taken from `CHANGELOG.md` -``` -- Added support for the `NO_COLOR` environment variable, see #1021 and #1031 (@eth-p) -- Adjust pager configuration to comply with `--wrap=never`, see #1255 (@gahag) -- Fixed non-printable characters display for redirected output, see #1061 (@gsomix) -``` +Take a look to this [guide](CONTRIBUTORS.md) ## Maintainers