So you want to contribute to smcat? We already love you!
To make this as easy as possible for you, here's some simple guidelines:
- All issues are welcome.
- These include bug reports, questions, feature requests and enhancement proposals
- GitLab's issue tracker is the easiest way to submit them.
- We prefer bug reports in steps taken - expected - found format.
- that makes it more easy to reproduce it, and concoct a solution that fits your expectation.
- If applicable, it is also nice when you provide
- the input you used and
- the environment (browser version/ os, or node.js version + os).
- template at the bottom
- In turn, we try to respond within a week.
This might or might not include an actual code fix.
- We prefer well documented pull requests based on the most recent version of the master branch.
- Code quality
- Additions pass eslint (as configured in this repo)
- Mocha tests prove your code does what it intends.
- Your code does not introduce regressions -
make checkproves this. - Code style (you know, petty things like indentations, where brackets go, how variables & parameters are named) fits in with the current code base.
- Plan to do something drastic?
Contact @SanderSpeaks on Twitter, or leave an issue on GitHub - state-machine-cat is released with a code of conduct, adapted from the contributor covenant.
- the code you add will be subject to GPL-3.0, just like the rest of smcat
- the code you add is your own original work
### steps taken
### expected
### found
### notes