If you found a bug or you'd like a new feature or change, you can raise it as an issue in GitHub. Please fill in all relevant information.
Before making a new one, please search the existing issues to check if your change has already been requested. Comment on an issue to let us know you're interested.
To get an overview of the project, read the README. Read the developer guide for help setting up a development environment.
You can contribute code for any issue by raising a pull request from your own fork of the repository. Raise an issue for your change if there isn't one already.
Please fill in the pull request template as accurately as possible, and try to match the pull request naming style described in the template.
If you have added, removed, or updated any external dependencies used in the project, please update the NOTICES file to reflect this.
When you raise a pull request for the first time, a bot will comment asking you to sign the Contributor License Agreement (CLA). Click the link in the comment to read and sign it. The pull request will update once you've signed.
When you raise a pull request, GitHub Actions workflows will run automatically to validate your change. Please check in your pull request that these are successful. For faster feedback you can raise a draft pull request before it's finished. You can ask us on your pull request for help to get it working.
These workflows involve publishing test and linting results as separate checks. GitHub Actions requires separate permissions in your fork to do this, which you can set in the repository settings under Actions > General > Workflow permissions > Select "Read and write permissions".
Read our common problems and their solutions to see if your problem is covered there.
For help with an issue you can post in the issue's comments.
You can also raise any question as a GitHub issue, and we'll get back to you with a response. Please note this will be public on GitHub.