summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAdrian Rivera <adrian.rivera.dev@gmail.com>2020-10-27 21:39:54 -0700
committerDavid Peter <sharkdp@users.noreply.github.com>2020-10-29 20:16:33 +0100
commit47ea99090f3d817d4a677195b7d2dcb86e7e831e (patch)
treea249a0065d97c0106121d5ee520a134e74aeb74c /CONTRIBUTING.md
parent1c1ba04c41376a823167a56f888d04f9f4145c54 (diff)
Style changes on CONTRIBUTORS
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..ccaf528a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,13 @@
+# Contributing
+
+### 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` is your PR's number or ticket and `@user` is you Github's username.
+