Contributions to this project are very welcome and will be fully credited.
You're encouraged to question everything about the project but, please, do it with respect and good manners (see our Code of Contuct for more information).
We accept contributions via Pull Requests on Github.
- Coding Standards: Make sure ESLint doesn't throw any errors. We pretty much follow what Airbnb says with a couple of exceptions.
- Create feature branches: It's important to be concise with your commits, so don't ask us to pull from your master branch.
- Add tests if applicable: Your patch probably won't be accepted if it doesn't have tests (but will depend on the situation).
- Document any change in behaviour: Make sure the
README.md, Postman files and any other relevant documentation are kept up-to-date. - Consider our release cycle: We follow SemVer v2.0.0.
- One pull request per feature: If you want to do more than one thing, send multiple pull requests.
- Send coherent history: Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
- Join the #shokku channel in our public Discord group. Sign up at https://discord.gg/HF6vEGF.
- File an issue on GitHub.
- Tweet to or DM @aldoborrero.