Documents that only agents/ at the repo root is tracked by git. .claude/agents/, .cursor/agents/, and .github/agents/ are gitignored install-sync outputs and must not be edited — they will be overwritten. Closes #2365 Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -316,13 +316,25 @@ get-shit-done/
|
||||
workflows/ — Workflow definitions (.md)
|
||||
references/ — Reference documentation (.md)
|
||||
templates/ — File templates
|
||||
agents/ — Agent definitions (.md)
|
||||
agents/ — Agent definitions (.md) — CANONICAL SOURCE
|
||||
commands/gsd/ — Slash command definitions (.md)
|
||||
tests/ — Test files (.test.cjs)
|
||||
helpers.cjs — Shared test utilities
|
||||
docs/ — User-facing documentation
|
||||
```
|
||||
|
||||
### Source of truth for agents
|
||||
|
||||
Only `agents/` at the repo root is tracked by git. The following directories may exist on a developer machine with GSD installed and **must not be edited** — they are install-sync outputs and will be overwritten:
|
||||
|
||||
| Path | Gitignored | What it is |
|
||||
|------|-----------|------------|
|
||||
| `.claude/agents/` | Yes (`.gitignore:9`) | Local Claude Code runtime sync |
|
||||
| `.cursor/agents/` | Yes (`.gitignore:12`) | Local Cursor IDE bundle |
|
||||
| `.github/agents/gsd-*` | Yes (`.gitignore:37`) | Local CI-surface bundle |
|
||||
|
||||
If you find that `.claude/agents/` has drifted from `agents/` (e.g., after a branch change), re-run `bin/install.js` to re-sync from the canonical source. Always edit `agents/` — never the derivative directories.
|
||||
|
||||
## Security
|
||||
|
||||
- **Path validation** — use `validatePath()` from `security.cjs` for any user-provided paths
|
||||
|
||||
Reference in New Issue
Block a user