on master help sign in
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.

commit49d7bf8c3908262115e15830111bd6ae511b9e84 authorAdrian Rivera <adrian.rivera.dev@gmail.com> dateMon 26 Oct 2020, 20:48 (6 years ago) parentdade4cc
1 file changed+16
README.md+16
README.md+16
@@ -676,6 +676,22 @@ bash assets/create.sh
676676cargo install --path . --locked --force
677677```
678678
679+## Contributors
680+
681+Please don't forget to update `CHANGELOG.md` and describe your changes, this makes the release of a new `bat` version much easier.
682+
683+Each entry should follow the next format:
684+- Short description of the change (one line)
685+- Number of the pull request
686+- Github's username
687+
688+See the next examples taken from `CHANGELOG.md`
689+```
690+- Added support for the `NO_COLOR` environment variable, see #1021 and #1031 (@eth-p)
691+- Adjust pager configuration to comply with `--wrap=never`, see #1255 (@gahag)
692+- Fixed non-printable characters display for redirected output, see #1061 (@gsomix)
693+```
694+
679695## Maintainers
680696
681697- [sharkdp](https://github.com/sharkdp)