Interested in contributing? Awesome! Before you do though, please read our Code of Conduct. We take it very seriously, and expect that you will as well.
There are many ways you can contribute! ❤️
- At this early stage of development we are not accepting bug reports or feature requests through GitHub. Yet.
For your contribution to be accepted:
- You must have signed the Contributor License Agreement (CLA).
- The test suite must be complete and pass.
- The changes must be approved by code review.
- Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
If the contribution doesn't meet the above criteria, you may fail our automated checks or a maintainer will discuss it with you. You can continue to improve a Pull Request by adding commits to the branch from which the PR was created.
Interested in knowing more about about pull requests at Slack?
- 🍴 Fork the repository on GitHub.
- 🏃 Clone/fetch your fork to your local development machine. It's a good idea to run the tests just to make sure everything is in order.
- 🌿 Create a new branch and check it out.
- 🔮 Make your changes and commit them locally. Magic happens here!
⤴️ Push your new branch to your fork. (e.g.git push username fix-issue-16).- 📥 Open a Pull Request on github.com from your new branch on your fork to
mainin this repository.
There are more details about processes and workflow in the Maintainer's Guide.