From 49d7bf8c3908262115e15830111bd6ae511b9e84 Mon Sep 17 00:00:00 2001 From: Adrian Rivera Date: Mon, 26 Oct 2020 20:48:52 -0700 Subject: [PATCH] From a TODO in #1211. Add documentation for contributors. This changes the README file and adds a new section `Contributors`. This section includes instructions to remind contributors to make an update to the changelog. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index ba34eea6..9357a30c 100644 --- a/README.md +++ b/README.md @@ -676,6 +676,22 @@ bash assets/create.sh 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) +``` + ## Maintainers - [sharkdp](https://github.com/sharkdp)