There are many ways to contribute to Aztec Monorepo.
Please read our disclaimer first
You can open an issue to suggest a feature or report a minor bug.
Before opening an issue, be sure to search through the existing open and closed issues, and consider posting a comment in one of those instead.
When requesting a new feature, include as many details as you can, especially around the use cases that motivate it. Features are prioritized according to the impact they may have on the ecosystem, so we appreciate information showing that the impact could be high.
If you would like to contribute code or documentation you may do so by forking the repository and submitting a pull request.
Any non-trivial code contribution must be first discussed with the maintainers in an issue (see Opening an issue). Only very minor changes are accepted without prior discussion.
When opening the pull request you will be presented with a template and a series of instructions. Read through it carefully and follow all the steps. Expect a review and feedback from the maintainers afterward.
If you're looking for a good place to start, look for issues labeled "good first issue"!
- I've provided a paragraph or two giving a summary of the change in the description, including relevant motivation and context.
- I've enabled auto-merge if the PR is ready to merge.
- I have updated the protocol specs in the docs (aka the yellow paper) when making changes to associated functionality (e.g. outward-facing spec changes).
- I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
- Every change is related to the PR description.
- I have linked this pull request to relevant issues (if any exist).