Contributing

Branch naming, PR process, and local checks before you open a pull request

Branch naming

Branches follow the type/short-description convention:

Prefix	Use for
feat/	New features or enhancements
fix/	Bug fixes

Examples from the repository: feat/events-text-first, fix/improve-recordings-page-load-times.

Keep the description short and hyphen-separated. Branch off main.

Opening a pull request

1. Run local checks

   Before pushing, run the checks listed below. Fix any failures before opening the PR.

2. Push your branch and open a PR against main

   Vercel will automatically generate a preview deployment and link it in the PR.

3. Request a review

   Tag a maintainer as reviewer. Include a short description of what changed and why, and link to the preview URL if relevant.

4. Address feedback and merge

   Once approved, the PR author or a maintainer merges into main. Merging triggers a production deploy.

Local checks

Run these before opening a PR:

pnpm lint

pnpm typecheck

pnpm test

If the test suite is not yet configured, skip pnpm test. Check with a maintainer.

If you changed a collection or global schema, also generate and commit the migration:

pnpm payload migrate:create

See Database migrations for details.

Getting access and asking questions

Ask a maintainer for:

• Repository access (GitHub organisation invite)
• Payload admin credentials for local development
• Vercel project access
• Third-party service credentials (Supabase, Resend, Stripe)

Contact the team at [e-mail] or reach out directly to a maintainer on the project.