]> git.r.bdr.sh - rbdr/sorting-hat-renderer/blame_incremental - CONTRIBUTING.md
Add jsdoc, fix linter
[rbdr/sorting-hat-renderer] / CONTRIBUTING.md
... / ...
CommitLineData
1# Contributing to Lissajous Renderer
2
3This app is intended to be part of a short demo for the gdljs community
4that uses the mindwave eeg to sort you into a house or ninja turtle
5personality. It's not really intended to go beyond that, however if you
6would like to contribute and improve it will be appreciated.
7
8## How to contribute
9
10Above All: Be nice, always.
11
12* Ensure the linter shows no warnings or errors
13* Don't break the CI
14* Make the PRs according to [Git Flow][gitflow]: (features go to
15 develop, hotfixes go to master)
16* Update the CHANGELOG
17
18[gitflow]: https://github.com/nvie/gitflow