> ## Documentation Index
> Fetch the complete documentation index at: https://wlumsa.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

<Steps>
  <Step title="Run local checks">
    Before pushing, run the checks listed below. Fix any failures before opening the PR.
  </Step>

  <Step title="Push your branch and open a PR against main">
    Vercel will automatically generate a preview deployment and link it in the PR.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Address feedback and merge">
    Once approved, the PR author or a maintainer merges into `main`. Merging triggers a production deploy.
  </Step>
</Steps>

## Local checks

Run these before opening a PR:

```bash theme={null}
pnpm lint
```

```bash theme={null}
pnpm typecheck
```

```bash theme={null}
pnpm test
```

<Note>
  If the test suite is not yet configured, skip `pnpm test`. Check with a maintainer.
</Note>

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

```bash theme={null}
pnpm payload migrate:create
```

See [Database migrations](/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 `msa@wlu.ca` or reach out directly to a maintainer on the project.