Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (36 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 3.52 KB
Raw

Contributing

Coursemap is currently a private project. Keep changes focused, reviewable and reproducible.

Workflow

  1. Create a branch prefixed with feat/, fix/ or refactor/.
  2. Make one coherent change and update tests and documentation with it.
  3. Run pnpm verify. For database changes, also run pnpm db:reset, pnpm db:test, pnpm db:lint and pnpm db:types.
  4. Open a pull request using the repository template.
  5. Merge only after required checks pass.

Use conventional commit subjects such as feat: add email sign-in or refactor: move catalogue reads to Supabase. Write in British English, use straight apostrophes and avoid em dashes.

Conventions

Follow code conventions for naming, comments and placement, and UI conventions for product components.

Verification

Command Purpose When required
pnpm check Formatting, repository conventions, lint and strict types During development and CI
pnpm test Unit and component regressions Included in local verification and CI
pnpm verify Check, unit/component tests, production build, anonymous access tests and whitespace Before hand-off or a PR
pnpm db:reset, pnpm db:test, pnpm db:lint, pnpm db:types, pnpm test:catalogue-db Local migrations, policies, schema, generated types and import integration Database changes; CI database gate
pnpm test:e2e Authenticated browser journeys using local Supabase Affected journeys; CI browser gate
pnpm audit --prod --audit-level=high Production dependency audit Dependency changes; CI quality gate

pnpm verify is the local application gate, not all CI jobs. Report checks that passed, failed or did not run. Do not run production builds concurrently because they share apps/web/.next. Database resets require a task-owned local stack. Documentation-only changes do not require a database reset.

Database changes

  • Put forward-only SQL migrations in supabase/migrations.
  • Enable RLS and add explicit grants and policies for every exposed relation.
  • Regenerate committed TypeScript database types from the local database after applying a migration.
  • Include tests for ownership boundaries and privileged actions.
  • Keep the local Supabase CLI version aligned with the pinned CI version.
  • Never expose a service-role key to browser code.

Catalogue changes

Catalogue data must include its source, catalogue year and retrieval provenance. Do not treat prototype fixtures, generated timetables or inferred prerequisite rules as authoritative ANU data.