diff --git a/README.md b/README.md index f4a7a18..f1fd498 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,16 @@ cv-generator/ ├── .bare/ bare repo (git objects, refs, config) ├── .git file pointing at .bare ├── .worktrees/ feature branch worktrees (one per CVG-N) -│ └── cvg-/ branch: feature/cvg- +│ └── cvg--feature-name/ branch: feature/cvg--feature-name └── main/ primary worktree, branch: main ``` All code lives inside worktrees. Don't try to check out files in the container directory itself. ```bash -git worktree add .worktrees/cvg- -b feature/cvg- main +git worktree add .worktrees/cvg--feature-name -b feature/cvg--feature-name main git worktree list -git worktree remove .worktrees/cvg- +git worktree remove .worktrees/cvg--feature-name ``` ## Monorepo @@ -105,7 +105,7 @@ Cluster manifests (Prometheus, ingress, cron jobs, secrets) live in a **separate ## Conventions - **Commits:** Conventional Commits, one-line header, scope is the Linear key (e.g. `feat(cvg-84): move CV parsing onto worker queue`). -- **Branches:** `feature/cvg-` matching the Linear issue. +- **Branches:** `feature/cvg--feature-name` matching the Linear issue. - **TypeScript:** strict, `exactOptionalPropertyTypes` enabled. Use `compact()` from `@cv/utils` for Prisma inputs that may contain `undefined`. - **Style (TS/JS):** functional patterns, guard clauses with braces, ternaries for simple conditionals, no `if/else` ladders, no `for` loops, no inline comments (code should be self-documenting). Biome enforces. - **GraphQL codegen** needs a running API (`localhost:3000/graphql`) for schema introspection.