Repository navigation
Development Guide
Kuray Karaaslan edited this page Oct 5, 2026
·
1 revision
pnpm install --frozen-lockfile
pnpm exec turbo run typecheck lint test build
pnpm devRequirements:
- Node
>= 24 - pnpm
>= 10
| Command | Purpose |
|---|---|
pnpm dev |
Start the Electron app |
pnpm build |
Build workspaces |
pnpm typecheck |
TypeScript checks |
pnpm lint |
ESLint |
pnpm test |
Vitest suites |
pnpm coverage |
Coverage gate |
pnpm depcruise |
Dependency/layer boundary check |
pnpm e2e |
Playwright Electron smoke |
pnpm format:check |
Formatting gate |
pnpm run docs:links |
Documentation link gate |
- Branch from
mainas<type>/<short-scope>. - Keep PRs small and focused.
- Ask before large feature work, especially around security, model gateway, or IPC.
- No AI attribution trailers in commits or PRs.
- Security reports do not go to public issues.
- Strict TypeScript.
- No
@ts-ignoreor@ts-expect-error. -
anyonly incatch. - Files should stay under the project's line-limit convention.
- Zod
safeParseat every untrusted boundary. - Shared contracts come from
@tepegoz/shared-types. - Services throw
AppError; boundaries map errors. - User-facing strings are localized English + Turkish in the same PR.
- New work targets a package or extension, not uncontrolled
apps/desktopgrowth.
phases/README.mddocs/architecture.mddocs/package-map.mddocs/engineering-rules.mddocs/threat-model.mddocs/adr/
CONTRIBUTING.mddocs/engineering-rules.mdpackage.jsondependency-cruiser.cjs