Style changes on CONTRIBUTORS

2020-10-27 21:39:54 -07:00 · 2020-10-27 21:39:54 -07:00 · 47ea99090f
parent 1c1ba04c41
commit 47ea99090f
2 changed files with 7 additions and 5 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -1,11 +1,13 @@
-# Contributors
+# Contributing

-## Add an entry to the changelog
+### 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. 
+Where `#123` is your PR's number or ticket and `@user` is you Github's username. 

--- a/README.md
+++ b/README.md
@ -676,9 +676,9 @@ bash assets/create.sh
 cargo install --path . --locked --force
 ```

-## Contributors
+## Contributing

-Take a look to this [guide](CONTRIBUTORS.md)
+Take a look to this [guide](CONTRIBUTING.md)

 ## Maintainers