add a contribution guide

1 files changed, 17 insertions, 0 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..f2af1cc
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,17 @@
+If you're interested in contributing and making [tessen](https://github.com/ayushnix/tessen) better,
+please ensure that
+
+- your bash code doesn't trigger errors or warnings from
+  [shellcheck](https://github.com/koalaman/shellcheck)
+
+  if you've used `# shellcheck disable` in your bash code, there should be a very good reason for it
+
+- your bash code has been formatted using [shfmt](https://github.com/mvdan/sh) with the following
+  settings
+
+  `-i 2 -ci -sr -bn`
+
+Please raise an [issue](https://github.com/ayushnix/tessen/issues/new/choose) if you have any
+questions.
+
+Thanks!