Architecture
Contributing
How to set up a dev environment and submit changes.
Iris is MIT-licensed and contributions are welcome. The short version:
-
Fork the repo and branch from
main(feat/...,fix/..., orchore/...). -
Set up locally — same steps as the quickstart.
-
Keep PRs focused: one feature or fix per PR.
-
Make sure checks pass before pushing:
pnpm lint && pnpm typecheck && pnpm test && pnpm build -
Open a PR against
maindescribing the motivation and the change.
A few conventions to know:
- UI components come from
@iris/ui— never hand-roll buttons, inputs, or cards. Add missing ones viapnpm --filter @iris/ui dlx shadcn@latest add <name>. - Colors and spacing use design tokens (
bg-background,text-muted-foreground, …) — no hardcoded Tailwind palette classes. - Data fetching (web) goes through Axios + React Query — no raw
fetch. - Schema changes require a Prisma migration: edit
packages/database/prisma/schema.prisma, thenpnpm db:migrate.
The full guide lives in CONTRIBUTING.md. For security vulnerabilities, follow SECURITY.md — please don't open public issues for those.