aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2017-08-28 21:37:28 -0500
committerBen Beltran <ben@nsovocal.com>2017-08-28 21:37:28 -0500
commit69c48e0767172cf806a70df2ecc3a59aaefb9f2b (patch)
tree148627bed3989237cf424f54c4728399b4e0f119 /CONTRIBUTING.md
parenta6b9035958a0e125d291ef1696c94d6a53a3c918 (diff)
parentb21a9771b4f02de35d224c898fbda5b359656e94 (diff)
Merge branch 'feature/rbdr-initial-dev' into develop
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md18
1 files changed, 18 insertions, 0 deletions
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