Contributing

Your first pull request can be small, and it is welcome.

We label every beginner-friendly task and promise a first review within three days. You do not need to know the whole codebase: a documentation fix or an extra test is a real contribution, and your name goes in the release notes.

Woman coding on a laptop in a bright office

From idea to merged

  1. 01

    Pick or propose a task

    Choose an issue labelled good first issue, or open one describing what you would like to change. Comment that you are taking it so nobody duplicates the work.

  2. 02

    Work on a branch

    Fork the repository, run npm install and npm test to check your setup, and make the change. Add a test, or a docs example, that shows it working.

  3. 03

    Open a pull request

    Describe what changed and why. Automated checks run the tests, the linter and a build of the documentation site, and the results appear in a minute.

  4. 04

    Respond to review

    A maintainer replies within three days. Reviews are about the change, never the person, and most pull requests are merged after one round of edits.

Good first issues

A small selection of open tasks. Each one links to a thread with hints from the maintainer who knows the area.

5 open tasks

Ground rules

Do I need to sign anything?

No contributor agreement is required. You certify with a sign-off line that you wrote the change or have the right to submit it.

What is the code of conduct?

Be kind, assume good faith and keep discussions about the work. Reports go to two maintainers who are not involved in the thread.

Can I be paid for contributing?

The project fund pays small bounties for security reports and larger features agreed in advance. Ask in the issue before you start.