diff options
| author | Ben Beltran <ben@nsovocal.com> | 2017-08-27 17:18:34 -0500 |
|---|---|---|
| committer | Ben Beltran <ben@nsovocal.com> | 2017-08-27 17:18:34 -0500 |
| commit | 465f0784a327c75305a967dee7ae27e573ea27ac (patch) | |
| tree | 2db4a58bd7fd910c0533fdb517eee67b1a01ba15 | |
| parent | 753ee4ebf0b838d45f31a40834918ef87ae81741 (diff) | |
Add contributing guide
| -rw-r--r-- | CONTRIBUTING.md | 18 |
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 |