X-Git-Url: https://git.r.bdr.sh/rbdr/sorting-hat-renderer/blobdiff_plain/dc7f608a828fc0b34a291af915727ab1f7d6ba0a..b78f678de4f242b2a364bbf0cc39c8ec61ee5357:/CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..19270e0
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# Contributing to Lissajous Renderer
+
+This app is intended to be part of a short demo for the gdljs community
+that uses the mindwave eeg to sort you into a house or ninja turtle
+personality. It's not really intended to go beyond that, however if you
+would like to contribute and improve it will be appreciated.
+
+## How to contribute
+
+Above All: Be nice, always.
+
+* Ensure the linter shows no warnings or errors
+* Don't break the CI
+* Make the PRs according to [Git Flow][gitflow]: (features go to
+  develop, hotfixes go to master)
+* Update the CHANGELOG
+
+[gitflow]: https://github.com/nvie/gitflow