added onboard and claude improve
This commit is contained in:
parent
6714a893d1
commit
80e03ce9fd
58
CLAUDE.md
58
CLAUDE.md
@ -3,49 +3,58 @@
|
|||||||
Apply unless repo-specific instructions override.
|
Apply unless repo-specific instructions override.
|
||||||
|
|
||||||
## Code style
|
## Code style
|
||||||
|
|
||||||
- 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 otherwise.
|
- Preserve existing behavior unless asked otherwise.
|
||||||
- Scope changes to the 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 (excl. comments, error handling).
|
||||||
- Max 25 logic lines/function (excl. comments, error handling).
|
- Too many params → struct/object. Too many vars → split/extract.
|
||||||
- Max 80 chars/line, 5 params/function, 5 local vars/function.
|
|
||||||
- Too many params → group into struct/object. Too many vars → split/extract.
|
|
||||||
- No global state. Explicit data flow.
|
- No global state. Explicit data flow.
|
||||||
|
|
||||||
## Comments & readability
|
## Comments & readability
|
||||||
|
|
||||||
- Document intent, not mechanics. Use project doc style (docstring, JSDoc, etc.).
|
- Document intent, not mechanics. Use project doc style (docstring, JSDoc, etc.).
|
||||||
- Explicit, consistent, meaningful names.
|
- Explicit, consistent, meaningful names. Straight control flow. No hidden side effects.
|
||||||
- Straight control flow. Extract complex conditions. 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?" Hacky fix → rebuild cleanly. Don't over-engineer.
|
||||||
|
|
||||||
|
## Session start
|
||||||
|
1. Read `tasks/LESSONS.md` — apply all lessons before touching anything.
|
||||||
|
2. Read `tasks/TODO.md` — understand current state.
|
||||||
|
3. If neither exists, create both before starting.
|
||||||
|
|
||||||
|
## Workflow
|
||||||
|
- Non-trivial task (3+ steps): write plan in `tasks/TODO.md` first. Confirm before implementing.
|
||||||
|
- Minimal changes unless broader refactor requested. State trade-offs.
|
||||||
|
- Use sub-agents to keep main context clean — one task per sub-agent. Invest more compute on hard problems.
|
||||||
|
- One question upfront if needed — never interrupt mid-task. *(Exception: orchestrators' mandatory validation gates — example, /init-project STEP 4/7, /ship-feature STEP 3 — are exempt.)*
|
||||||
|
- Bug received → fix directly: check logs, find root cause, resolve autonomously.
|
||||||
|
- If something goes wrong: STOP and re-plan — never push through.
|
||||||
|
- Report deviations: minor/justified → explain. Significant/unjustified → ask.
|
||||||
|
- Root causes only. No temporary fixes. Never assume — verify paths, APIs, variables before use.
|
||||||
|
|
||||||
## 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 was verified and what wasn't.
|
2. Report what was verified and what wasn't.
|
||||||
3. List remaining risks and surviving deviations.
|
3. List remaining risks and surviving deviations.
|
||||||
|
4. Never mark complete without proof it works. Bar: "would a staff engineer approve this?"
|
||||||
|
5. After any correction: append to `tasks/LESSONS.md` — `[date] | what went wrong | rule to avoid it`.
|
||||||
|
|
||||||
## Workflow
|
## Task tracking (`tasks/TODO.md`)
|
||||||
|
1. Plan → write before implementing.
|
||||||
|
2. Confirm → explicit approval before starting.
|
||||||
|
3. Track → mark done as you go.
|
||||||
|
4. Summarize → high-level summary at each major step.
|
||||||
|
|
||||||
- Analyze before changing. Brief plan first.
|
-## Context Navigation
|
||||||
- Minimal changes unless broader refactor requested.
|
-When you need to understand the codebase, docs, or any files in this project:
|
||||||
- State trade-offs clearly.
|
-1. ALWAYS query the knowledge graph first: `/graphify query "your question"`
|
||||||
- Report deviations: minor/justified → keep and explain. Significant/unjustified → ask.
|
-2. Only read raw files if I explicitly say "read the file" or "look at the raw file"
|
||||||
- Stop if requirements unclear. Ask, don't guess. No invented context.
|
-3. Use `graphify-out/wiki/index.md` as your navigation entrypoint for browsing structure
|
||||||
|
|
||||||
## Context Navigation
|
|
||||||
When you need to understand the codebase, docs, or any files in this project:
|
|
||||||
1. ALWAYS query the knowledge graph first: `/graphify query "your question"`
|
|
||||||
2. Only read raw files if I explicitly say "read the file" or "look at the raw file"
|
|
||||||
3. Use `graphify-out/wiki/index.md` as your navigation entrypoint for browsing structure
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -72,8 +81,7 @@ All web API endpoints MUST be versioned from day one: `/api/v1/...`, `/api/v2/..
|
|||||||
- Breaking changes → new version (`v2`). Old version stays functional — clients migrate at their own pace.
|
- Breaking changes → new version (`v2`). Old version stays functional — clients migrate at their own pace.
|
||||||
- Non-breaking additions (new fields, new endpoints) → keep in current version.
|
- Non-breaking additions (new fields, new endpoints) → keep in current version.
|
||||||
- Each version is a self-contained contract. Never modify existing version behavior to match a newer one.
|
- Each version is a self-contained contract. Never modify existing version behavior to match a newer one.
|
||||||
- Router structure must reflect versioning explicitly (e.g. `api/v1/routes/`, `api/v2/routes/` or equivalent namespace/prefix pattern for the language/framework used).
|
- Router structure must reflect versioning explicitly (e.g. `api/v1/routes/`, `api/v2/routes/`).
|
||||||
|
|
||||||
|
|
||||||
## Security — non-negotiable defaults
|
## Security — non-negotiable defaults
|
||||||
|
|
||||||
|
|||||||
5
TODO.md
Normal file
5
TODO.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
faire skill / agent SEO + GEO
|
||||||
|
|
||||||
|
faire skill / agent clean code
|
||||||
|
|
||||||
|
faire skill / agent do doc (CLAUDE.md, INSTALL.md, README.md, Docker files, Comments)
|
||||||
@ -188,6 +188,29 @@ This applies in all modes — the path is always the same directory as the gener
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## PHASE 5c — tasks/ scaffold
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ls tasks/LESSONS.md tasks/TODO.md 2>/dev/null
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Both exist** → nothing to do. ✅
|
||||||
|
- **tasks/TODO.md missing** → create it with:
|
||||||
|
```
|
||||||
|
# TODO
|
||||||
|
<!-- Claude writes tasks here before implementing. Format: - [ ] task -->
|
||||||
|
```
|
||||||
|
- **tasks/LESSONS.md missing** → create it with:
|
||||||
|
```
|
||||||
|
# Lessons learned
|
||||||
|
<!-- Format: [date] | what went wrong | rule to avoid it -->
|
||||||
|
```
|
||||||
|
- Print: "📋 tasks/TODO.md and tasks/LESSONS.md ready."
|
||||||
|
|
||||||
|
Applies in all modes (single project, Option A, B, C). Path = same directory as generated `CLAUDE.md`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## PHASE 6 — GSD v2 ROADMAP (optional)
|
## PHASE 6 — GSD v2 ROADMAP (optional)
|
||||||
|
|
||||||
Ask: "Generate a GSD v2 ROADMAP.md for multi-session feature management? (yes / skip)"
|
Ask: "Generate a GSD v2 ROADMAP.md for multi-session feature management? (yes / skip)"
|
||||||
|
|||||||
@ -57,7 +57,7 @@ Changes → back to STEP 3. Approved → continue.
|
|||||||
|
|
||||||
## STEP 5 — SCAFFOLD
|
## STEP 5 — SCAFFOLD
|
||||||
Load `$HOME/.claude/agents/scaffolder.md`. Pass: BRIEF + DESIGN + `~/.claude/templates/project-CLAUDE.md` + `~/.claude/CLAUDE.md`.
|
Load `$HOME/.claude/agents/scaffolder.md`. Pass: BRIEF + DESIGN + `~/.claude/templates/project-CLAUDE.md` + `~/.claude/CLAUDE.md`.
|
||||||
Creates: CLAUDE.md, settings, structure, config, empty entry points, .gitignore, .env.example. NO README, NO features.
|
Creates: CLAUDE.md, settings, structure, config, empty entry points, .gitignore, .env.example, tasks/TODO.md, tasks/LESSONS.md. NO README, NO features.
|
||||||
Verify: `git init` + build passes.
|
Verify: `git init` + build passes.
|
||||||
|
|
||||||
## STEP 5b — CREATE README
|
## STEP 5b — CREATE README
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user