So you want to contribute to watskeburt? 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
- GitHub's issue tracker is the easiest way to submit them.
- In turn, we try to respond within two weeks.
This might or might not include an actual code fix. - If there's something that doesn't fit an issue, feel free to contact us on twitter @mcmeadow.
- We prefer well documented pull requests based on the most recent version of the main branch.
- Code quality
- watskeburt has a bunch of automated checks (test coverage, depcruise,
linting, code formatting). They also run on the CI, but you can save yourself
time by running them locally already:
npm run check(oryarn run check). - Do add tests for new and updated code. It not only helps PR reviewers a lot, it'll prevent regressions in the future.
- Code style (you know, petty things like indentations, where brackets go, how variables & parameters are named) fits in with the current code base.
- watskeburt has a bunch of automated checks (test coverage, depcruise,
linting, code formatting). They also run on the CI, but you can save yourself
time by running them locally already:
- Plan to do something drastic?
Leave an issue on GitHub, so we can talk about it. - watskeburt is released with a code of conduct, adapted from the contributor covenant.
- the code you add will be subject to the MIT license, just like the rest of watskeburt
- the code you add is your own original work