Skip to content
PesaKit PesaKit

Contributing

First-time contributor path

Section titled “First-time contributor path”
  1. Fork the repository and create a branch from main.
  2. Install dependencies with Yarn classic.
  3. Run yarn ci:check before you open a pull request.
  4. Add or update tests for behavior changes.
  5. Update the docs when public behavior changes.

Areas that welcome contributions

Section titled “Areas that welcome contributions”
  • New endpoint support with tests and docs
  • Error handling and validation improvements
  • Callback examples and troubleshooting guides
  • Contributor experience fixes in CI, docs, and repo templates

Local commands

Section titled “Local commands”
Terminal window
yarn install
yarn docs:dev
yarn ci:check

Optional docs environment variables

Section titled “Optional docs environment variables”
  • PUBLIC_GA_MEASUREMENT_ID enables Google Analytics in the Starlight site build.

More detail

Section titled “More detail”

The root repository guide in CONTRIBUTING.md is the maintainers’ source of truth for pull request expectations, release assumptions, and repository policies.