How to contribute
From first issue to merged pull request.
Here is how a change travels from an issue to a merged pull request.
Find something to work on
Browse the issue tracker; the good first issue label is curated for newcomers. Good first contributions are small and self-contained: a reproducible bug, a rough edge in the UI, a missing piece of documentation. Comment on the issue before starting so nobody duplicates the work.
Propose the change
Fork the repository, create a branch for your change, and keep it to one concern. Explain why the change exists in the pull request description, not only what it does. Commits and pull requests covers the message format, the sign-off, and the rest of the pull request rules.
What review looks for
- Does it solve a real problem, and is the problem stated?
- Does it match the surrounding code's style and conventions?
- Is the user-facing behavior still honest and predictable?
Documentation counts
These docs are markdown files in the website repository, and fixing them is a contribution like any other.
Related
- The coding standard for the rules a reviewer will hold the change to.
- Running the tests for what to run before you push.