Thank you for investing your time in contributing to our project! We would love for you to contribute and make it even better ✨. Please read our Code of Conduct to keep our community open and respectable. 💖
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. Additionally, we lay out some general coding rules.
Since we are using the GitHub flow, check up on Setting up Git and Collaborating with pull requests if you are completely new to Open Source development. To get an overview of the project, read the README.
Participating on a project probably starts at the issues section.
If you spot a problem with our package, search if an issue already exists. If a related issue doesn't exist, you can open a new issue. If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. We might ask you to provide a minimal reproduction example to support our research. Or even better, you can submit a Pull Request with a fix.
Scan through our existing issues to find one that interests you. Check out one of our issues labeled as help wanted or good first issue. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new major feature, please open an issue first and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
Smaller features may be built by you directly and submitted as a pull request.
To contribute actual code, fork the repository and create a new working branch. When committing, please adhere to the Conventional Commits ruleset. Other syntax-specific requirements will be enforced by the project’s linter.
To ensure consistency throughout the source code, keep these rules in mind as you are working:
- All features or bug fixes must be tested by one or more specs (unit-tests).
- All public API methods must be documented.
Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.
When you're finished with the changes, create a pull request, also known as a PR.
- If you’re solving an issue, don't forget to link the PR to it.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can make any changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations! 🎉
Our team thanks you as you are now part of our contributors community. Once your PR is merged, your contributions will probably be publicly visible on the next package release. ✨