diff options
| author | Adrian Rivera <adrian.rivera.dev@gmail.com> | 2020-10-26 20:48:52 -0700 |
|---|---|---|
| committer | David Peter <sharkdp@users.noreply.github.com> | 2020-10-29 20:16:33 +0100 |
| commit | 49d7bf8c3908262115e15830111bd6ae511b9e84 (patch) | |
| tree | 17489169aa99d3711f6869d9eeedef21e12fcb6f | |
| parent | dade4cc6f36075e6a9872220cb640be049382e6c (diff) | |
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.
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -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) |