mirror of
https://github.com/coder/coder.git
synced 2026-09-21 12:44:32 +08:00
docs: add explicit read instructions for non-Claude-Code agents (#23403)
The @ imports at the bottom of this file are auto-loaded by Claude Code but silently ignored by other agent runtimes (Coder Agents, Zed, etc.). Add an explicit fallback so those agents know what to read and when.
This commit is contained in:
@@ -297,6 +297,27 @@ comments preserve important context about why code works a certain way.
|
||||
@.claude/docs/PR_STYLE_GUIDE.md
|
||||
@.claude/docs/DOCS_STYLE_GUIDE.md
|
||||
|
||||
If your agent tool does not auto-load `@`-referenced files, read these
|
||||
manually before starting work:
|
||||
|
||||
**Always read:**
|
||||
|
||||
- `.claude/docs/WORKFLOWS.md` — dev server, git workflow, hooks
|
||||
|
||||
**Read when relevant to your task:**
|
||||
|
||||
- `.claude/docs/GO.md` — Go patterns and modern Go usage (any Go changes)
|
||||
- `.claude/docs/TESTING.md` — testing patterns, race conditions (any test changes)
|
||||
- `.claude/docs/DATABASE.md` — migrations, SQLC, audit table (any DB changes)
|
||||
- `.claude/docs/ARCHITECTURE.md` — system overview (orientation or architecture work)
|
||||
- `.claude/docs/PR_STYLE_GUIDE.md` — PR description format (when writing PRs)
|
||||
- `.claude/docs/OAUTH2.md` — OAuth2 and RFC compliance (when touching auth)
|
||||
- `.claude/docs/TROUBLESHOOTING.md` — common failures and fixes (when stuck)
|
||||
- `.claude/docs/DOCS_STYLE_GUIDE.md` — docs conventions (when writing `docs/`)
|
||||
|
||||
**For frontend work**, also read `site/AGENTS.md` before making any changes
|
||||
in `site/`.
|
||||
|
||||
## Local Configuration
|
||||
|
||||
These files may be gitignored, read manually if not auto-loaded.
|
||||
|
||||
Reference in New Issue
Block a user