Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (19 loc) · 748 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 748 Bytes
Raw

Contributing

This is a small template for one-night lightning-demo events. Fixes and improvements that help every event are welcome. Copy, styling, or rules that only fit your event belong in your fork, next to your lib/content.ts.

Before you open a PR

bun install
bun run lint
bun run typecheck
bun run build

All three checks must pass. There is no test suite; the build is the gate. npm ci still works from package-lock.json if you are not using Bun.

Ground rules

  • Keep diffs small and single-purpose.
  • Convex functions keep validators on both args and returns.
  • The board query is public. It must never return email, userId, or host-only fields.
  • No secrets in the repo. .env.local stays untracked.