Thank you for investing your time in contributing to our project!
To get an overview of the project, please read the README.
Please check to see what types of contributions we accept before making changes.
If you spot a problem or want to suggest an enhancement, search if it already exists. If a related issue does not exist, you can open a new issue here on GitHub.
Scan through our existing issues to find one that interests you.
You can narrow down the search using labels as filters.
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.
- Fork the repository.
- Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
- Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
- Using GitHub Desktop:
- Create a working branch and start with your changes!
Commit the changes once you are happy with them.
Always write a clear log message for your commits. One-line messages are fine for small changes.
When you're finished with the changes, create a pull request, also known as a PR.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other 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 and Thanks for your contribution.