Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.1 KB

File metadata and controls

40 lines (29 loc) · 1.1 KB

Contributing

Thanks for helping improve attioom.

Development setup

npm install
npm run build

Checks (all must pass before a PR)

npm run check:proprietary   # no internal company names, emails, or project refs
npm run typecheck
npm run lint
npm test
npm run build

The example Next.js app in example/nextjs must typecheck and build:

npm run build
cd example/nextjs && npm install && npm run typecheck && npm run build

Pull requests

  • Keep changes focused and minimal.
  • Use conventional commit messages when possible (feat:, fix:, docs:, chore:).
  • Do not add proprietary identifiers — the check:proprietary gate enforces this.
  • docs/setup.md and sql/schema.sql are authoritative for env var names and table/column names.

Code conventions

  • All environment variables are read through src/config.ts — no process.env elsewhere in src/.
  • Fix cross-file inconsistencies by aligning call sites to existing code, not redesigning APIs.
  • Tests that depend on configurable policy should set env explicitly rather than relying on hardcoded defaults.