mirror of
https://github.com/sharkdp/bat.git
synced 2024-12-25 15:58:51 +01:00
Adds a CONTRIBUTORS file
This commit is contained in:
parent
456216ab37
commit
1c1ba04c41
11
CONTRIBUTORS.md
Normal file
11
CONTRIBUTORS.md
Normal file
@ -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.
|
||||
|
14
README.md
14
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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user