|
1 | | -name: 📝 CLAUDE.md Audit |
| 1 | +name: 📝 Agent Instructions Audit |
2 | 2 |
|
3 | 3 | on: |
4 | 4 | pull_request: |
|
10 | 10 | - "**/*.md" |
11 | 11 |
|
12 | 12 | concurrency: |
13 | | - group: claude-md-audit-${{ github.event.pull_request.number }} |
| 13 | + group: agent-instructions-audit-${{ github.event.pull_request.number }} |
14 | 14 | cancel-in-progress: true |
15 | 15 |
|
16 | 16 | jobs: |
@@ -48,29 +48,36 @@ jobs: |
48 | 48 | --allowedTools "Read,Glob,Grep,Bash(git diff:*)" |
49 | 49 |
|
50 | 50 | prompt: | |
51 | | - You are reviewing a PR to check whether any CLAUDE.md files or .claude/rules/ files need updating. |
| 51 | + You are reviewing a PR to check whether any agent instruction files need updating. |
| 52 | +
|
| 53 | + In this repo: |
| 54 | + - Root shared agent guidance lives in `AGENTS.md`. |
| 55 | + - Root `CLAUDE.md` is only a Claude Code adapter that imports `AGENTS.md`. |
| 56 | + - Subdirectories may still have scoped `CLAUDE.md` files. |
| 57 | + - `.claude/rules/` contains additional Claude Code guidance. |
52 | 58 |
|
53 | 59 | ## Your task |
54 | 60 |
|
55 | 61 | 1. Run `git diff origin/main...HEAD --name-only` to see which files changed in this PR. |
56 | | - 2. For each changed directory, check if there's a CLAUDE.md in that directory or a parent directory. |
57 | | - 3. Determine if any CLAUDE.md or .claude/rules/ file should be updated based on the changes. Consider: |
| 62 | + 2. For each changed directory, check the applicable instruction files: root `AGENTS.md`, any `CLAUDE.md` in that directory or a parent directory, and relevant `.claude/rules/` files. |
| 63 | + 3. Determine if any instruction file should be updated based on the changes. Consider: |
58 | 64 | - New files/directories that aren't covered by existing documentation |
59 | | - - Changed architecture or patterns that contradict current CLAUDE.md guidance |
60 | | - - New dependencies, services, or infrastructure that Claude should know about |
61 | | - - Renamed or moved files that are referenced in CLAUDE.md |
| 65 | + - Changed architecture or patterns that contradict current agent guidance |
| 66 | + - New dependencies, services, or infrastructure that agents should know about |
| 67 | + - Renamed or moved files that are referenced in an instruction file |
62 | 68 | - Changes to build commands, test patterns, or development workflows |
63 | 69 |
|
64 | 70 | ## Response format |
65 | 71 |
|
66 | 72 | If NO updates are needed, respond with exactly: |
67 | | - ✅ CLAUDE.md files look current for this PR. |
| 73 | + ✅ Agent instruction files look current for this PR. |
68 | 74 |
|
69 | 75 | If updates ARE needed, respond with a short list: |
70 | | - 📝 **CLAUDE.md updates suggested:** |
| 76 | + 📝 **Agent instruction updates suggested:** |
| 77 | + - `AGENTS.md`: [what should be added/changed] |
71 | 78 | - `path/to/CLAUDE.md`: [what should be added/changed] |
72 | 79 | - `.claude/rules/file.md`: [what should be added/changed] |
73 | 80 |
|
74 | | - Keep suggestions specific and brief. Only flag things that would actually mislead Claude in future sessions. |
| 81 | + Keep suggestions specific and brief. Only flag things that would actually mislead agents in future sessions. |
75 | 82 | Do NOT suggest updates for trivial changes (bug fixes, small refactors within existing patterns). |
76 | | - Do NOT suggest creating new CLAUDE.md files - only updates to existing ones. |
| 83 | + Do NOT suggest creating new CLAUDE.md files - only updates to existing instruction files. |
0 commit comments