You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Team reference for the custom Claude Code tooling in this repo: the slash-command **skills**, the
4
-
**agents** they dispatch, the **hooks** that fire automatically, the auto-loaded **rules**, and the
5
-
shared coding **standards**.
3
+
Team reference for the custom Claude Code tooling in this repo: the slash-command **skills**, the **agents** they dispatch, the **hooks** that fire automatically, the auto-loaded **rules**, and the shared coding **standards**.
6
4
7
5
> Claude tooling is shared via the repo.
8
-
> On first use after pulling, Claude Code asks each teammate to approve the hooks (workspace trust).
9
-
> The hook scripts need `jq`; without it, they degrade to no-ops rather than breaking.
6
+
> On first use after pulling, Claude Code might ask you to approve the hooks (workspace trust). The hook scripts need `jq`; without it, they quietly do nothing instead of erroring.
10
7
11
8
---
12
9
@@ -20,8 +17,7 @@ shared coding **standards**.
20
17
21
18
**Reviewing a teammate's PR:**`/code-review <PR-number>`, then your manual review on top.
22
19
23
-
**Writing tests:** the unit-test-writer agent owns `tests/PHPUnit/`; the test rule routes work to it
24
-
automatically.
20
+
**Writing tests:** the unit-test-writer agent owns `tests/PHPUnit/`; the test rule routes work to it automatically.
25
21
26
22
27
23
---
@@ -34,48 +30,47 @@ _Slash-commands that we manually invoke._
34
30
35
31
### `/understand`
36
32
37
-
Run **before** starting a complex task, to research an area and capture what you learn. Args:
38
-
`[module-or-topic] [JIRA-ID]`, both optional.
33
+
Run **before** starting a complex task, to research an area and capture what you learn. Args: `[module-or-topic] [JIRA-ID]`, both optional.
39
34
40
-
Recalls any existing notes, researches the code, cross-references your assumptions against it,
41
-
offers
42
-
an optional interview, then dispatches `note-taker` to file durable facts and task context as
43
-
local notes.
35
+
Recalls any existing notes, researches the code, cross-references your assumptions against it, offers an optional interview, then dispatches `note-taker` to file durable facts and task context as local notes.
Run on **your own** branch before opening a PR. Args: `[JIRA-ID] [base-branch]`, both optional.
50
42
51
-
Dispatches the pr-readiness agent to check test coverage, docs, and code quality, then give a ready
52
-
or not-ready verdict. Does not write the PR description.
43
+
Dispatches the pr-readiness agent to check test coverage, docs, and code quality, then give a ready or not-ready verdict. Does not write the PR description.
Run on a PHP file for an on-demand cleanliness review. Args: `[FULL|CHANGES] <file>` (scope defaults to `CHANGES`).
66
+
67
+
The manual counterpart to the automatic hook: it runs the same `php-review` agent for a more thorough pass. `CHANGES` reviews only what you changed; `FULL` reviews the whole file.
Every listed skill's name and description is fed into Claude's context each session, which costs a
77
-
few tokens per skill. To trim skills you don't use, add a `skillOverrides` map to your personal
78
-
`.claude/settings.local.json` (gitignored, so it stays yours and does not affect the team):
73
+
Every listed skill's name and description is fed into Claude's context each session, which costs a few tokens per skill. To trim skills you don't use, add a `skillOverrides` map to your personal `.claude/settings.local.json` (gitignored, so it stays yours and does not affect the team):
79
74
80
75
```json
81
76
{
@@ -99,65 +94,57 @@ Keys are skill names (e.g. `understand`, `describe-pr`), not paths. Omit a skill
99
94
100
95
## Agents
101
96
102
-
_Automatically invoked by skills or hooks; can also be manually dispatched ("Use agent X for
103
-
TASK")._
97
+
_Automatically invoked by skills or hooks; can also be manually dispatched ("Use agent X for TASK")._
104
98
105
99
> Claude Docs: https://code.claude.com/docs/en/sub-agents
106
100
107
101
### `php-review`
108
102
109
-
Haiku, read-only. Dispatched by the Stop hook or manually.
110
-
111
-
Reviews the PHP lines you changed this session for cleanliness (function focus, comment noise,
112
-
coupling, over-engineering) and returns fixes. Never edits.
103
+
Read-only. Reviews changed PHP for cleanliness (function focus, comment noise, coupling, over-engineering) and suggests fixes; never edits. It runs automatically after you edit PHP (via the Stop hook), and you can also run it on demand with `/php-review`.
Writes and updates Jest tests (the colocated `*.test.js` files next to module `resources/js`
135
-
sources), following the existing JS suite's conventions. Dispatched manually.
123
+
Writes and updates Jest tests (the colocated `*.test.js` files next to module `resources/js` sources), following the existing JS suite's conventions. Dispatched manually.
Background. Runs the project's tests and linters (PHP unit, JS unit, integration, PHPCS, PHPStan) and distills the output to a crisp pass/fail summary, keeping heavy tool output out of the main context. Use it for any test or lint run; the test-writer agents hand off verification to it.
130
+
131
+
Source: [agents/ci.md](../agents/ci.md)
132
+
139
133
### `copy-editor`
140
134
141
-
Haiku, read-only. Canonicalizes a user-facing string (sentence case, brand capitalization,
142
-
concision) against the copy guidelines and returns a suggestion. The caller passes the draft plus
143
-
its context; a human still has the final word. Dispatch when writing or changing UI copy.
135
+
Read-only. Canonicalizes a user-facing string (sentence case, brand capitalization, concision) against the copy guidelines and returns a suggestion. The caller passes the draft plus its context; a human still has the final word. Dispatch when writing or changing UI copy.
Haiku, read-only. Recalls the developer's local research notes - crisp canonical knowledge per
150
-
module/topic, plus throwaway per-task context. Returns the relevant notes or reports none exist.
151
-
Dispatched by `/understand`, by other skills, or manually to recall a note.
141
+
Read-only. Recalls your local research notes for a module or topic and returns what's relevant (or reports that none exist). Dispatched by `/understand`, by other skills, or manually.
Sonnet. Records an insight into the developer's local research notes and owns their conventions:
158
-
files durable facts into a crisp per-module/topic domain note (deduped and pruned), and loose per-task
159
-
context into a throwaway task note. Dispatched by `/understand`, by other skills, or manually to
160
-
record a note.
147
+
Records what you learn into your local research notes: durable facts about a module or topic, plus looser per-task context. Dispatched by `/understand`, by other skills, or manually.
Stop. When your turn settles, asks Claude to review each touched PHP file whose content changed
183
-
since its last review. Each state is reviewed once, so the loop terminates.
168
+
Stop. When your turn settles, asks Claude to review each touched PHP file whose content changed since its last review. Each state is reviewed once, so the loop terminates.
Both hooks read `hooks/config.local.json` (gitignored). Copy `config.example.json` to `config.local.json` and set `"php-review": false` to turn them off locally. No config file, or a missing key, means enabled. The `/php-review` skill is unaffected: a manual invocation always runs.
175
+
187
176
---
188
177
189
178
## Rules
@@ -195,15 +184,13 @@ _Autoloaded by Claude, passive context._
195
184
196
185
### `unit-test-conventions.md`
197
186
198
-
Loads on first read of a `tests/PHPUnit/**/*.php` file. Routes all test writing through the
199
-
unit-test-writer agent instead of inline test code.
187
+
Loads on first read of a `tests/PHPUnit/**/*.php` file. Routes all test writing through the unit-test-writer agent instead of inline test code.
@@ -215,7 +202,6 @@ _Our conventions, not a regular Claude Code folder._
215
202
216
203
### code-quality.md
217
204
218
-
The shared code-quality rules. Single source of truth for `/code-review` and `/pr-readiness`. The
219
-
php-review agent keeps a tuned subset inline and does not read this file.
205
+
The shared code-quality rules. Single source of truth for `/code-review` and `/pr-readiness`. The php-review agent keeps a tuned subset inline and does not read this file.
0 commit comments