docs(claude-md): merge workflow/todo + emphasis discipline
P5: merge the TODO volet of ## Workflow with ## Task tracking into a single ## Planning & TODO section (when to plan / exempt scope / how to track), placed right after ## Workflow. Drops the "see Workflow" cross-ref; no rule lost. P6: reserve emphasis caps (NEVER/ALWAYS/MUST/FORBIDDEN/ONLY/No…) for the ~9 critical rules only (security, never-invent, append-only memory, radical honesty, never-assume, STOP, SPA-ban, supply-chain dep vetting). Downgrade process/style dressing to normal case so the critical anchors stand out. Typography only — no content or meaning changes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X3e8LaH2vymmxyh36h3jFU
This commit is contained in:
parent
493b6b904e
commit
663b16c472
77
CLAUDE.md
77
CLAUDE.md
@ -6,7 +6,7 @@ Apply unless repo-specific instructions override.
|
|||||||
- Simple, readable, maintainable > clever or compact.
|
- Simple, readable, maintainable > clever or compact.
|
||||||
- One responsibility per function/method.
|
- One responsibility per function/method.
|
||||||
- Preserve existing behavior unless asked.
|
- Preserve existing behavior unless asked.
|
||||||
- Scope changes to task. No unrelated edits.
|
- Scope changes to task — no unrelated edits.
|
||||||
|
|
||||||
## Limits (adapt to language)
|
## Limits (adapt to language)
|
||||||
- Max 25 logic lines/function, 80 chars/line, 5 params, 5 local vars.
|
- Max 25 logic lines/function, 80 chars/line, 5 params, 5 local vars.
|
||||||
@ -17,14 +17,14 @@ Apply unless repo-specific instructions override.
|
|||||||
|
|
||||||
## Comments & readability
|
## Comments & readability
|
||||||
- Document intent, not mechanics. Use project doc style (docstring, JSDoc…).
|
- Document intent, not mechanics. Use project doc style (docstring, JSDoc…).
|
||||||
- Explicit, consistent, meaningful names. Straight control flow.
|
- Explicit, consistent, meaningful names. Straight control flow,
|
||||||
No hidden side effects.
|
no hidden side effects.
|
||||||
|
|
||||||
## Refactoring
|
## Refactoring
|
||||||
- Priority: safety → readability → consistency.
|
- Priority: safety → readability → consistency.
|
||||||
- Remove dead code, stale comments, obsolete flags after changes.
|
- Remove dead code, stale comments, obsolete flags after changes.
|
||||||
- Non-trivial change: ask "more elegant solution exists?"
|
- Non-trivial change: ask "more elegant solution exists?"
|
||||||
Hacky fix → rebuild clean. No over-engineering.
|
Hacky fix → rebuild clean, no over-engineering.
|
||||||
|
|
||||||
## Session start
|
## Session start
|
||||||
1. Read `.claude/memory/` — 5 registries (decisions, learnings, blockers,
|
1. Read `.claude/memory/` — 5 registries (decisions, learnings, blockers,
|
||||||
@ -34,51 +34,50 @@ Apply unless repo-specific instructions override.
|
|||||||
(templates: `~/.claude/templates/memory/`).
|
(templates: `~/.claude/templates/memory/`).
|
||||||
|
|
||||||
## Workflow
|
## Workflow
|
||||||
- Task touches logic (new behavior, control flow, state, API,
|
- Confirm before implementing only when real trade-offs exist (multiple
|
||||||
dependencies) → plan in `.claude/tasks/TODO.md` first, decomposed into
|
|
||||||
subtasks. One complex task still needs plan. Borderline case (single
|
|
||||||
file, small obvious logic change) → skip plan, stay pragmatic.
|
|
||||||
- Confirm before implementing ONLY when real trade-offs exist (multiple
|
|
||||||
valid approaches, breaking change, destructive action) — else proceed.
|
valid approaches, breaking change, destructive action) — else proceed.
|
||||||
- Exempt from TODO.md: pure reads, explanations, questions, typos,
|
|
||||||
cosmetic CSS, single config-value change. Same scope as `/hotfix`
|
|
||||||
(≤2 files, obvious fix).
|
|
||||||
- Minimal changes unless broader refactor requested. State trade-offs.
|
- Minimal changes unless broader refactor requested. State trade-offs.
|
||||||
- Sub-agents keep main context clean — one task per sub-agent.
|
- Sub-agents keep main context clean — one task per sub-agent.
|
||||||
More compute on hard problems. Task fans out across independent
|
More compute on hard problems. Task fans out across independent
|
||||||
items (many files, parallel searches, multi-point checks) → delegate
|
items (many files, parallel searches, multi-point checks) → delegate
|
||||||
to sub-agents, don't iterate serially. Default to delegation for
|
to sub-agents, don't iterate serially. Default to delegation for
|
||||||
multi-file exploration. Counters Opus 4.8 tendency to under-delegate.
|
multi-file exploration. Counters Opus 4.8 tendency to under-delegate.
|
||||||
- One question upfront if needed — never interrupt mid-task.
|
- One question upfront if needed — don't interrupt mid-task.
|
||||||
*Exception: skill-mandated gates and checkpoints (orchestrator
|
*Exception: skill-mandated gates and checkpoints (orchestrator
|
||||||
validation gates, approval gates, darwin checkpoints) always fire.*
|
validation gates, approval gates, darwin checkpoints) always fire.*
|
||||||
- Bug received → fix directly: check logs, find root cause, resolve
|
- Bug received → fix directly: check logs, find root cause, resolve
|
||||||
autonomously.
|
autonomously.
|
||||||
- Something goes wrong → STOP, re-plan. Never push through.
|
- Something goes wrong → STOP, re-plan. Never push through.
|
||||||
- Deviations: minor or clearly justified → do, explain after.
|
- Deviations: minor or clearly justified → do, explain after.
|
||||||
Significant or shaky justification → ask BEFORE deviating.
|
Significant or shaky justification → ask before deviating.
|
||||||
- Root causes only. No temp fixes. Never assume — verify paths, APIs,
|
- Root causes only. No temp fixes. Never assume — verify paths, APIs,
|
||||||
variables before use.
|
variables before use.
|
||||||
|
|
||||||
|
## Planning & TODO (`.claude/tasks/TODO.md`)
|
||||||
|
|
||||||
|
- When to plan: task touches logic (new behavior, control flow, state,
|
||||||
|
API, dependencies) → write it in `.claude/tasks/TODO.md` first,
|
||||||
|
decomposed into subtasks. One complex task still needs a plan.
|
||||||
|
Borderline case (single file, small obvious logic change) → skip plan,
|
||||||
|
stay pragmatic.
|
||||||
|
- Exempt (skip TODO.md): pure reads, explanations, questions, typos,
|
||||||
|
cosmetic CSS, single config-value change. Same scope as `/hotfix`
|
||||||
|
(≤2 files, obvious fix).
|
||||||
|
- How to track, once a task qualifies:
|
||||||
|
1. Plan → task written before code.
|
||||||
|
2. Decompose → one subtask = one coherent change.
|
||||||
|
3. Track → check off as you go.
|
||||||
|
4. Summarize → high-level note at each milestone.
|
||||||
|
|
||||||
## After code changes
|
## After code changes
|
||||||
1. Run tests, lint, build, type-check if available.
|
1. Run tests, lint, build, type-check if available.
|
||||||
2. Report what verified, what not.
|
2. Report what verified, what not.
|
||||||
3. List remaining risks, surviving deviations.
|
3. List remaining risks, surviving deviations.
|
||||||
4. Never mark complete without proof it works.
|
4. Don't mark complete without proof it works.
|
||||||
Bar: "would staff engineer approve?"
|
Bar: "would staff engineer approve?"
|
||||||
5. Correction or notable event → capitalize to right registry
|
5. Correction or notable event → capitalize to right registry
|
||||||
(see "Memory registries").
|
(see "Memory registries").
|
||||||
|
|
||||||
## Task tracking (`.claude/tasks/TODO.md`)
|
|
||||||
|
|
||||||
Any write/modify task touching logic. Skip reads + trivial edits
|
|
||||||
(see Workflow).
|
|
||||||
|
|
||||||
1. Plan → task written before code.
|
|
||||||
2. Decompose → one subtask = one coherent change.
|
|
||||||
3. Track → check off as you go.
|
|
||||||
4. Summarize → high-level note at each milestone.
|
|
||||||
|
|
||||||
## Memory registries (`.claude/memory/`)
|
## Memory registries (`.claude/memory/`)
|
||||||
|
|
||||||
Five registries persist across sessions. Read all at session start.
|
Five registries persist across sessions. Read all at session start.
|
||||||
@ -94,11 +93,11 @@ past entries; curation (merge, mark superseded, compress) ONLY via
|
|||||||
| `journal.md` | date heading | 3-5 lines/session — done, decided, blocked |
|
| `journal.md` | date heading | 3-5 lines/session — done, decided, blocked |
|
||||||
| `evals.md` | EVAL-XXX | Quality check of Claude's output + method + anomalies + action |
|
| `evals.md` | EVAL-XXX | Quality check of Claude's output + method + anomalies + action |
|
||||||
|
|
||||||
**Language — registries ALWAYS English.** Rationale: consistent vocab,
|
**Language — registries always English.** Rationale: consistent vocab,
|
||||||
lower token cost, cross-project reuse. User-facing CAPITALIZE prompts may
|
lower token cost, cross-project reuse. User-facing CAPITALIZE prompts may
|
||||||
mirror user's language; final written entry English.
|
mirror user's language; final written entry English.
|
||||||
|
|
||||||
**Format — registries ALWAYS caveman.** Drop articles + filler, fragments
|
**Format — registries always caveman.** Drop articles + filler, fragments
|
||||||
OK, short synonyms. Technical terms exact, code blocks unchanged, errors
|
OK, short synonyms. Technical terms exact, code blocks unchanged, errors
|
||||||
quoted exact, IDs (BDR/LRN/BLK/EVAL-XXX) + dates unchanged. Pattern:
|
quoted exact, IDs (BDR/LRN/BLK/EVAL-XXX) + dates unchanged. Pattern:
|
||||||
`[thing] [action] [reason]. [next step].` Rationale: registries load
|
`[thing] [action] [reason]. [next step].` Rationale: registries load
|
||||||
@ -117,7 +116,7 @@ compress manually or via claude.ai on demand.
|
|||||||
**Proactive capitalization (Claude's responsibility):**
|
**Proactive capitalization (Claude's responsibility):**
|
||||||
After substantive milestone (bug fix with real root cause, feature
|
After substantive milestone (bug fix with real root cause, feature
|
||||||
shipped, non-trivial commit, design choice, surprising discovery, dead
|
shipped, non-trivial commit, design choice, surprising discovery, dead
|
||||||
end with lesson) → **offer to capitalize inline**, do NOT wait for user.
|
end with lesson) → **offer to capitalize inline**, do not wait for user.
|
||||||
Pre-fill entry from context; user approves/edits before write.
|
Pre-fill entry from context; user approves/edits before write.
|
||||||
Completion skills (`/ship-feature`, `/feat`, `/bugfix`, `/hotfix`,
|
Completion skills (`/ship-feature`, `/feat`, `/bugfix`, `/hotfix`,
|
||||||
`/commit-change`) automate this via CAPITALIZE step.
|
`/commit-change`) automate this via CAPITALIZE step.
|
||||||
@ -147,23 +146,23 @@ portfolio, blog, e-commerce, docs):
|
|||||||
islands for interactive parts.
|
islands for interactive parts.
|
||||||
- **Next.js** = when dynamic SSR needed (personalized content, server-side
|
- **Next.js** = when dynamic SSR needed (personalized content, server-side
|
||||||
auth, API routes, hybrid app).
|
auth, API routes, hybrid app).
|
||||||
- **React SPA** = valid ONLY for: admin panels, dashboards, auth-gated
|
- **React SPA** = valid only for: admin panels, dashboards, auth-gated
|
||||||
apps, internal tools — anything that does NOT need indexing.
|
apps, internal tools — anything that does not need indexing.
|
||||||
- **Mixed project** (public + admin): Astro/Next for public, React island
|
- **Mixed project** (public + admin): Astro/Next for public, React island
|
||||||
(`client:only`) for admin.
|
(`client:only`) for admin.
|
||||||
- At brainstorming (`/init-project` STEP 1, `/ship-feature` STEP 1): if
|
- At brainstorming (`/init-project` STEP 1, `/ship-feature` STEP 1): if
|
||||||
project is public website and user hasn't specified framework, PROPOSE
|
project is public website and user hasn't specified framework, propose
|
||||||
Astro and EXPLAIN why not SPA. Never silently pick React CRA.
|
Astro and explain why not SPA. Never silently pick React CRA.
|
||||||
|
|
||||||
## Web APIs — always versioned
|
## Web APIs — always versioned
|
||||||
|
|
||||||
All web API endpoints MUST be versioned from day one: `/api/v1/...`.
|
All web API endpoints must be versioned from day one: `/api/v1/...`.
|
||||||
|
|
||||||
- New project → start at `/api/v1/`. No bare `/api/` routes.
|
- New project → start at `/api/v1/`, no bare `/api/` routes.
|
||||||
- Breaking changes → new version (`v2`). Old version stays functional —
|
- Breaking changes → new version (`v2`). Old version stays functional —
|
||||||
clients migrate at own pace.
|
clients migrate at own pace.
|
||||||
- Non-breaking additions (new fields, new endpoints) → current version.
|
- Non-breaking additions (new fields, new endpoints) → current version.
|
||||||
- Each version is self-contained contract. Never modify existing version
|
- Each version is self-contained contract. Don't modify existing version
|
||||||
behavior to match newer one.
|
behavior to match newer one.
|
||||||
- Router structure reflects versioning explicitly (e.g. `api/v1/routes/`).
|
- Router structure reflects versioning explicitly (e.g. `api/v1/routes/`).
|
||||||
|
|
||||||
@ -230,7 +229,7 @@ Apply at every dev step: design, scaffolding, implementation, review.
|
|||||||
|
|
||||||
## Skill routing
|
## Skill routing
|
||||||
|
|
||||||
Request matches available skill → invoke via Skill tool FIRST. No direct
|
Request matches available skill → invoke via Skill tool first — no direct
|
||||||
answer, no other tools before. Skill workflows beat ad-hoc answers.
|
answer, no other tools before. Skill workflows beat ad-hoc answers.
|
||||||
|
|
||||||
Key routing rules:
|
Key routing rules:
|
||||||
@ -274,16 +273,16 @@ where listed, else say so instead of improvising.
|
|||||||
Single source for all design/UI routing. Task touches design/UI →
|
Single source for all design/UI routing. Task touches design/UI →
|
||||||
mobilize tools by scope. Reinforced by design-toolchain-reminder hook
|
mobilize tools by scope. Reinforced by design-toolchain-reminder hook
|
||||||
(injects on UI signals).
|
(injects on UI signals).
|
||||||
- Trivial (≤2 files, single cosmetic value) → /hotfix, NO toolchain.
|
- Trivial (≤2 files, single cosmetic value) → /hotfix, no toolchain.
|
||||||
- Build UI (new component, page, screen, redesign) → ui-ux-pro-max
|
- Build UI (new component, page, screen, redesign) → ui-ux-pro-max
|
||||||
(plan/build) + frontend-design (anti AI-slop) + Magic MCP `/ui`
|
(plan/build) + frontend-design (anti AI-slop) + Magic MCP `/ui`
|
||||||
(21st.dev scaffold) + emil-design-eng (polish pass)
|
(21st.dev scaffold) + emil-design-eng (polish pass)
|
||||||
+ design-motion-principles (when motion) + design-html (static HTML).
|
+ design-motion-principles (when motion) + design-html (static HTML).
|
||||||
- Design system / brand → design-consultation FIRST (aesthetic, type,
|
- Design system / brand → design-consultation first (aesthetic, type,
|
||||||
color, spacing, motion), THEN build tools above.
|
color, spacing, motion), THEN build tools above.
|
||||||
- Review / audit → design-review (visual QA + fix) + emil-design-eng lens
|
- Review / audit → design-review (visual QA + fix) + emil-design-eng lens
|
||||||
+ design-motion-principles (audit mode).
|
+ design-motion-principles (audit mode).
|
||||||
Scope doubt (trivial tweak vs real UI change?) → do NOT silently skip
|
Scope doubt (trivial tweak vs real UI change?) → do not silently skip
|
||||||
toolchain: ask user, or default to Build tier.
|
toolchain: ask user, or default to Build tier.
|
||||||
Design gate (automatic): lightweight skills (feat, hotfix, bugfix) detect
|
Design gate (automatic): lightweight skills (feat, hotfix, bugfix) detect
|
||||||
UI/style signals; signals found + ui-ux-pro-max inactive → ask user
|
UI/style signals; signals found + ui-ux-pro-max inactive → ask user
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user