Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (20 loc) · 786 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (20 loc) · 786 Bytes
Raw

Contributing

Thanks for helping improve SupaMail.

Before opening a pull request:

  1. Open or reference an issue for behavior changes.

  2. Keep the change focused on the reusable mailbox mirror and its public interfaces. Product-specific identity systems and account orchestration are out of scope.

  3. Use Node 24 and pnpm 10.

  4. Run:

    pnpm install --frozen-lockfile
pnpm typecheck
pnpm test
pnpm build

For sync, migration, schema, lock, reconcile, or health changes, also run pnpm test:db:live. Protocol changes should run the relevant GreenMail or Dovecot smoke test described in docs/agent/verification.md.

Never put mailbox credentials, API tokens, private messages, or customer data in issues, fixtures, logs, commits, or pull requests.