summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTORS.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTORS.md')
-rw-r--r--CONTRIBUTORS.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
new file mode 100644
index 00000000..7690f7d2
--- /dev/null
+++ b/CONTRIBUTORS.md
@@ -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.
+