thomas-agentkit 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/cli.js +0 -1
- package/package.json +1 -1
- package/templates/.cursor/rules/agentkit.md +11 -10
- package/templates/.github/copilot-instructions.md +1 -9
- package/templates/AGENTS.md +67 -32
- package/templates/CHANGE-EXPLANATION.md +20 -4
- package/templates/CLAUDE.md +2 -12
- package/templates/CODE-QUALITY.md +5 -15
- package/templates/IMPLEMENTATION-BRIEF-TEMPLATE.md +2 -0
- package/templates/PRD-TEMPLATE.md +2 -0
- package/templates/SECURITY-CHECKLIST.md +2 -2
- package/templates/TESTING.md +1 -1
- package/templates/WORKFLOWS.md +13 -86
package/README.md
CHANGED
|
@@ -166,7 +166,7 @@ Interactive personalization only applies during `agentkit init` when files are c
|
|
|
166
166
|
Template set mappings:
|
|
167
167
|
|
|
168
168
|
- `minimal`: `AGENTS.md`
|
|
169
|
-
- `standard`: `AGENTS.md`, `CHANGE-EXPLANATION.md`, `CODE-QUALITY.md`, `DESIGN-SYSTEM.md`,
|
|
169
|
+
- `standard`: `AGENTS.md`, `CHANGE-EXPLANATION.md`, `CODE-QUALITY.md`, `DESIGN-SYSTEM.md`, `.github/pull_request_template.md`
|
|
170
170
|
- `full`: all bundled templates, including AI tool adapters and planning/testing/security guides
|
|
171
171
|
|
|
172
172
|
AI tool mappings:
|
|
@@ -268,3 +268,5 @@ AgentKit should stay:
|
|
|
268
268
|
- safe by default
|
|
269
269
|
- useful immediately
|
|
270
270
|
- not overengineered
|
|
271
|
+
|
|
272
|
+
Installed guidance is **AGENTS-first**: `AGENTS.md` is enough for daily coding, including required change explanations after file edits. Companion files are loaded on explicit triggers (UI, review, security, stack, planning when requested), not on every task. The `full` template set adds optional guides such as `WORKFLOWS.md`, `TESTING.md`, and planning templates.
|
package/dist/cli.js
CHANGED
package/package.json
CHANGED
|
@@ -6,21 +6,22 @@ Use this rule as a repository guidance router for Cursor agents and composer wor
|
|
|
6
6
|
|
|
7
7
|
- Follow `AGENTS.md` first.
|
|
8
8
|
- Treat `AGENTS.md` as the source of truth for repository-wide agent behavior.
|
|
9
|
-
-
|
|
9
|
+
- Do not load companion files for routine coding unless a trigger in `AGENTS.md` applies or the user asks.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## When Relevant
|
|
12
12
|
|
|
13
|
-
-
|
|
14
|
-
- `
|
|
15
|
-
-
|
|
16
|
-
- `
|
|
17
|
-
-
|
|
18
|
-
- `
|
|
19
|
-
- `
|
|
13
|
+
- **File edits (final message):** change-explanation format in `AGENTS.md` and `CHANGE-EXPLANATION.md`.
|
|
14
|
+
- **UI / styling / layout:** `DESIGN-SYSTEM.md` or the project design-system path from `AGENTS.md`.
|
|
15
|
+
- **Review / refactor / dependencies:** `CODE-QUALITY.md`.
|
|
16
|
+
- **Tests / QA strategy:** `TESTING.md` if present.
|
|
17
|
+
- **Auth / secrets / PII:** `SECURITY-CHECKLIST.md` if present.
|
|
18
|
+
- **Stack-specific code:** `STACK.md` if present.
|
|
19
|
+
- **Planning docs requested:** create from `PRD-TEMPLATE.md` or `IMPLEMENTATION-BRIEF-TEMPLATE.md` under the project's briefs path.
|
|
20
|
+
- **Process map (optional):** `WORKFLOWS.md` if present.
|
|
20
21
|
|
|
21
22
|
## Cursor Behavior
|
|
22
23
|
|
|
23
24
|
- Prefer existing repository patterns over generic generated patterns.
|
|
24
25
|
- Keep changes scoped and reviewable.
|
|
25
26
|
- Do not change foundational architecture, schema, dependencies, or theme primitives without explicit approval.
|
|
26
|
-
-
|
|
27
|
+
- After modifying files, end every task with a change explanation per `AGENTS.md` (summary, what changed, verification, risks, review focus). Scale depth to the change; do not skip for small fixes.
|
|
@@ -2,15 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Follow `AGENTS.md` first. It is the primary source of truth for this repository's AI-agent guidance.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
- `CODE-QUALITY.md`
|
|
8
|
-
- `WORKFLOWS.md`
|
|
9
|
-
- `CHANGE-EXPLANATION.md`
|
|
10
|
-
- `DESIGN-SYSTEM.md`
|
|
11
|
-
- `TESTING.md`
|
|
12
|
-
- `SECURITY-CHECKLIST.md`
|
|
13
|
-
- `STACK.md`
|
|
5
|
+
Do not load companion files for routine coding. Use `AGENTS.md` triggers: change explanation after file edits; `CODE-QUALITY.md` for review/refactors; design-system path or `DESIGN-SYSTEM.md` for UI; `TESTING.md`, `SECURITY-CHECKLIST.md`, or `STACK.md` when present and relevant; planning templates only when explicitly requested.
|
|
14
6
|
|
|
15
7
|
For files covered by additional GitHub instructions under `.github/instructions/`, apply those path-specific instructions together with this file.
|
|
16
8
|
|
package/templates/AGENTS.md
CHANGED
|
@@ -10,24 +10,44 @@ This is the primary instruction file for AI coding agents working in this reposi
|
|
|
10
10
|
|
|
11
11
|
Follow this file first. It defines the repository-wide operating rules for agents.
|
|
12
12
|
|
|
13
|
-
Use companion guides only when
|
|
13
|
+
Use companion guides only when a trigger below applies. Do not load or restate every guide by default.
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
For routine bugfixes and small features, do not open `WORKFLOWS.md`, planning templates, or optional guides unless a trigger applies or the user asks.
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
## When To Use Other Guides
|
|
18
18
|
|
|
19
|
-
|
|
|
19
|
+
| Trigger | Action |
|
|
20
20
|
| --- | --- |
|
|
21
|
-
| Any
|
|
22
|
-
|
|
|
23
|
-
|
|
|
24
|
-
|
|
|
25
|
-
|
|
|
26
|
-
|
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
21
|
+
| Any file edits (final message) | Use the change-explanation format in **After Coding (Required)**; see `CHANGE-EXPLANATION.md` for detail |
|
|
22
|
+
| UI, components, styling, layout | Read `[design system path, e.g. docs/design-system.md]` or `DESIGN-SYSTEM.md` |
|
|
23
|
+
| Review, refactor, dependencies | Read `CODE-QUALITY.md` |
|
|
24
|
+
| Tests, fixtures, QA strategy | Read `TESTING.md` if present |
|
|
25
|
+
| Auth, permissions, secrets, PII | Read `SECURITY-CHECKLIST.md` if present |
|
|
26
|
+
| Stack-specific code | Read `STACK.md` if present |
|
|
27
|
+
| User or issue requests a PRD | Create from `PRD-TEMPLATE.md` under `[briefs path, e.g. docs/briefs]` |
|
|
28
|
+
| User or issue requests an implementation brief | Create from `IMPLEMENTATION-BRIEF-TEMPLATE.md` under `[briefs path, e.g. docs/briefs]` |
|
|
29
|
+
| Release or branching process (optional) | Read `WORKFLOWS.md` if present |
|
|
30
|
+
|
|
31
|
+
### Optional Guides (Full Template Set)
|
|
32
|
+
|
|
33
|
+
These files are not installed with the standard template set. Do not assume they exist unless present in the repository:
|
|
34
|
+
|
|
35
|
+
- `TESTING.md`
|
|
36
|
+
- `SECURITY-CHECKLIST.md`
|
|
37
|
+
- `PRD-TEMPLATE.md`
|
|
38
|
+
- `IMPLEMENTATION-BRIEF-TEMPLATE.md`
|
|
39
|
+
- `WORKFLOWS.md`
|
|
40
|
+
|
|
41
|
+
## Planning Artifacts
|
|
42
|
+
|
|
43
|
+
Use this decision tree before creating planning documents:
|
|
44
|
+
|
|
45
|
+
- **Tiny obvious fix** — implement directly; no PRD or brief required.
|
|
46
|
+
- **Product uncertainty** — create a PRD from `PRD-TEMPLATE.md` only when the user, issue, or task explicitly requests planning documentation. Save it under `[briefs path, e.g. docs/briefs]`.
|
|
47
|
+
- **Multi-file engineering with meaningful risk** — create an implementation brief from `IMPLEMENTATION-BRIEF-TEMPLATE.md` only when the user, issue, or task explicitly requests it. Save it under `[briefs path, e.g. docs/briefs]`.
|
|
48
|
+
- **Security-sensitive change** — follow `SECURITY-CHECKLIST.md` if present.
|
|
49
|
+
|
|
50
|
+
Do not read planning templates on every task. Copy and fill them only when planning documentation is requested.
|
|
31
51
|
|
|
32
52
|
## Local Guidance
|
|
33
53
|
|
|
@@ -45,23 +65,23 @@ If a subdirectory contains its own `AGENTS.md` or equivalent local guidance, fol
|
|
|
45
65
|
- Validate external input at system boundaries.
|
|
46
66
|
- Keep public APIs and persisted data shapes stable unless the task requires a change.
|
|
47
67
|
- Ask before destructive commands, broad refactors, schema changes, dependency additions, or security-sensitive changes.
|
|
48
|
-
- Run the narrowest useful checks before
|
|
49
|
-
-
|
|
68
|
+
- Run the narrowest useful checks before finishing (use **Project Commands** below).
|
|
69
|
+
- After any coding work that changes files, end with a change explanation per **After Coding (Required)**. Do not skip this for small fixes.
|
|
70
|
+
- Watch for common AI mistakes: invented APIs or commands, placeholder logic that looks production-ready, client-only authorization, and tests that do not exercise changed behavior.
|
|
71
|
+
- When reviewing or flagging issues, use severity: **Blocker** (must fix), **Concern** (should fix soon), **Suggestion** (optional).
|
|
72
|
+
- For review, refactor, or dependency work, read `CODE-QUALITY.md` for the full checklist.
|
|
50
73
|
|
|
51
74
|
## Before Coding
|
|
52
75
|
|
|
53
76
|
Before making meaningful code changes:
|
|
54
77
|
|
|
55
78
|
1. Confirm the task, scope, and acceptance criteria.
|
|
56
|
-
2.
|
|
57
|
-
3.
|
|
58
|
-
4.
|
|
59
|
-
5.
|
|
60
|
-
6. Read relevant companion guidance from the Reference Map.
|
|
61
|
-
7. Identify the smallest complete approach.
|
|
62
|
-
8. Ask for clarification if requirements, risk, or approval boundaries are unclear.
|
|
79
|
+
2. Inspect nearby code, tests, and existing patterns.
|
|
80
|
+
3. Read at most one triggered companion from **When To Use Other Guides** if it applies.
|
|
81
|
+
4. For non-trivial work: link to or create an issue in [issue tracker, e.g. Linear or GitHub Issues] and use an appropriate branch when the project expects branches.
|
|
82
|
+
5. Ask for clarification if requirements, risk, or approval boundaries are unclear.
|
|
63
83
|
|
|
64
|
-
Tiny fixes can skip
|
|
84
|
+
Tiny fixes can skip issue-and-branch ceremony when the change is obvious and low risk.
|
|
65
85
|
|
|
66
86
|
## During Coding
|
|
67
87
|
|
|
@@ -74,7 +94,7 @@ While implementing:
|
|
|
74
94
|
- Add or update tests when behavior changes.
|
|
75
95
|
- For UI work, follow `[design system path, e.g. docs/design-system.md]` and preserve existing interaction patterns.
|
|
76
96
|
- For stack-specific work, read `STACK.md` when present.
|
|
77
|
-
- Document meaningful decisions in the
|
|
97
|
+
- Document meaningful decisions in the change explanation when they matter.
|
|
78
98
|
|
|
79
99
|
## Approval Boundaries
|
|
80
100
|
|
|
@@ -87,20 +107,33 @@ Ask before:
|
|
|
87
107
|
- Performing broad refactors or large formatting-only rewrites.
|
|
88
108
|
- Editing generated, vendored, or external-source files unless the task explicitly requires it.
|
|
89
109
|
|
|
110
|
+
## After Coding (Required)
|
|
111
|
+
|
|
112
|
+
If you modified any files in the repository, your **final message** must include a change explanation.
|
|
113
|
+
|
|
114
|
+
This is how developers catch up on agent work. It is required for bugfixes, refactors, and small edits—not only large features or PRs. Scale section depth to the change; do not omit the explanation because the diff is small.
|
|
115
|
+
|
|
116
|
+
Do not write a separate change-explanation file unless the project asks for one. Use this structure in your reply:
|
|
117
|
+
|
|
118
|
+
- **Summary** — outcome in plain language (behavior delivered, not only files touched).
|
|
119
|
+
- **What changed** — main files or areas; what, why, and how each fits existing patterns.
|
|
120
|
+
- **Key decisions** — approach, alternatives, trade-offs (skip when straightforward).
|
|
121
|
+
- **Verification** — checks run and results; note any skipped checks and why.
|
|
122
|
+
- **Risks or limitations** — merge blockers, untested paths, follow-up (use "None identified" for trivial low-risk fixes when appropriate).
|
|
123
|
+
- **Suggested review focus** — where the developer should look first.
|
|
124
|
+
|
|
125
|
+
See `CHANGE-EXPLANATION.md` for examples and style rules.
|
|
126
|
+
|
|
90
127
|
## Before Finishing
|
|
91
128
|
|
|
92
129
|
Before marking work complete:
|
|
93
130
|
|
|
94
131
|
1. Re-read the original request and acceptance criteria.
|
|
95
132
|
2. Confirm the implementation satisfies the requested scope.
|
|
96
|
-
3. Run the narrowest relevant checks
|
|
97
|
-
- `[test command, e.g. npm test]`
|
|
98
|
-
- `[lint command, e.g. npm run lint]`
|
|
99
|
-
- `[build/check command, e.g. npm run build]` for larger changes
|
|
133
|
+
3. Run the narrowest relevant checks from **Project Commands**.
|
|
100
134
|
4. Review the diff for unrelated changes.
|
|
101
135
|
5. Confirm no unnecessary dependencies, schema changes, theme changes, or broad refactors were introduced.
|
|
102
|
-
6.
|
|
103
|
-
7. If `CHANGE-EXPLANATION.md` exists, follow it for the final handoff.
|
|
136
|
+
6. Include the change explanation from **After Coding (Required)** in your final message.
|
|
104
137
|
|
|
105
138
|
## Project Commands
|
|
106
139
|
|
|
@@ -125,7 +158,9 @@ Never commit API keys, tokens, private keys, or local `.env` values. Keep secret
|
|
|
125
158
|
|
|
126
159
|
## Stack
|
|
127
160
|
|
|
128
|
-
|
|
161
|
+
When `STACK.md` is present (for example after a preset install), read it before changing stack-specific code.
|
|
162
|
+
|
|
163
|
+
Otherwise document the real stack for this project:
|
|
129
164
|
|
|
130
165
|
- [Primary framework]
|
|
131
166
|
- [Language/runtime]
|
|
@@ -2,13 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
## Purpose
|
|
4
4
|
|
|
5
|
-
Use this guide
|
|
5
|
+
Use this guide **after every task that modifies repository files**.
|
|
6
6
|
|
|
7
|
-
The goal is to help the developer
|
|
7
|
+
The goal is to help the developer get up to speed quickly: what changed, why it changed, how it works, what was verified, and what deserves review attention.
|
|
8
8
|
|
|
9
|
-
This is a
|
|
9
|
+
This is a **response format** for agent messages. Do **not** create a new markdown file per task unless the project explicitly asks for one.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Research-only tasks that do not edit files do not require this format.
|
|
12
|
+
|
|
13
|
+
## When Required
|
|
14
|
+
|
|
15
|
+
| Situation | Change explanation |
|
|
16
|
+
| --- | --- |
|
|
17
|
+
| Any bugfix, feature, refactor, config, or doc edit in the repo | **Required** — follow this guide in your final message |
|
|
18
|
+
| Research, options, or questions with no file edits | Not required |
|
|
19
|
+
| User asks only to explain existing code (no edits) | Not required |
|
|
20
|
+
|
|
21
|
+
Scale depth to the size of the change. A one-line fix still needs a short explanation; a large feature needs full sections.
|
|
22
|
+
|
|
23
|
+
## Change Explanation Format
|
|
12
24
|
|
|
13
25
|
### Summary
|
|
14
26
|
|
|
@@ -35,6 +47,8 @@ Include when relevant:
|
|
|
35
47
|
- trade-offs or constraints
|
|
36
48
|
- assumptions made because requirements were unclear
|
|
37
49
|
|
|
50
|
+
Skip this section when the change is straightforward and has no meaningful trade-offs.
|
|
51
|
+
|
|
38
52
|
### Verification
|
|
39
53
|
|
|
40
54
|
List checks run, such as:
|
|
@@ -58,6 +72,8 @@ Call out anything the developer should know before merging or shipping:
|
|
|
58
72
|
- performance concerns
|
|
59
73
|
- follow-up cleanup
|
|
60
74
|
|
|
75
|
+
Use "None identified" when appropriate for very small, low-risk changes.
|
|
76
|
+
|
|
61
77
|
### Suggested Review Focus
|
|
62
78
|
|
|
63
79
|
Tell the developer where to focus review attention.
|
package/templates/CLAUDE.md
CHANGED
|
@@ -2,18 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Claude Code guidance for this repository.
|
|
4
4
|
|
|
5
|
-
Follow `AGENTS.md` first.
|
|
5
|
+
Follow `AGENTS.md` first. It is the source of truth for operating rules, triggers for companion guides, planning artifacts, and required change explanations.
|
|
6
6
|
|
|
7
|
-
When
|
|
8
|
-
|
|
9
|
-
- `CODE-QUALITY.md`
|
|
10
|
-
- `WORKFLOWS.md`
|
|
11
|
-
- `CHANGE-EXPLANATION.md`
|
|
12
|
-
- `DESIGN-SYSTEM.md`
|
|
13
|
-
- `TESTING.md`
|
|
14
|
-
- `SECURITY-CHECKLIST.md`
|
|
15
|
-
- `STACK.md`
|
|
16
|
-
|
|
17
|
-
Keep context focused. Do not load companion files unless they are relevant to the task.
|
|
7
|
+
Do not load companion files for routine coding. Read or create from other guides only when `AGENTS.md` **When To Use Other Guides** applies or the user asks.
|
|
18
8
|
|
|
19
9
|
Do not duplicate repository rules here. Update `AGENTS.md` or the relevant companion guide instead.
|
|
@@ -43,17 +43,7 @@ Use clear severity when reviewing or explaining issues:
|
|
|
43
43
|
|
|
44
44
|
Run the narrowest useful checks first, then broaden verification for larger changes.
|
|
45
45
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
|
-
npm test
|
|
50
|
-
npm run lint
|
|
51
|
-
npm run build
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
Remove commands that do not apply.
|
|
55
|
-
|
|
56
|
-
For deeper testing guidance, use `TESTING.md` when present.
|
|
46
|
+
Use the commands documented in `AGENTS.md` **Project Commands**. For deeper testing strategy, read `TESTING.md` when present.
|
|
57
47
|
|
|
58
48
|
## Dependency Policy
|
|
59
49
|
|
|
@@ -78,14 +68,14 @@ Watch for common AI-generated issues:
|
|
|
78
68
|
- client-only validation or authorization for sensitive actions
|
|
79
69
|
- excessive comments explaining obvious code instead of clarifying intent
|
|
80
70
|
|
|
81
|
-
##
|
|
71
|
+
## Change Explanation Standard
|
|
82
72
|
|
|
83
|
-
Every completed change
|
|
73
|
+
Every completed change that edits files must end with a developer-facing explanation that follows `CHANGE-EXPLANATION.md` in the agent's final message.
|
|
74
|
+
|
|
75
|
+
At minimum, cover:
|
|
84
76
|
|
|
85
77
|
- What changed.
|
|
86
78
|
- Why it changed.
|
|
87
79
|
- What checks were run.
|
|
88
80
|
- Known risks or limitations.
|
|
89
81
|
- Follow-up work, if any.
|
|
90
|
-
|
|
91
|
-
Use `CHANGE-EXPLANATION.md` when present for the final developer-facing handoff.
|
|
@@ -76,9 +76,9 @@ Avoid these common AI-generated security problems:
|
|
|
76
76
|
- adding permissive CORS or CSP rules to fix local issues
|
|
77
77
|
- assuming user IDs, workspace IDs, or tenant IDs from untrusted input
|
|
78
78
|
|
|
79
|
-
##
|
|
79
|
+
## Change Explanation Requirements
|
|
80
80
|
|
|
81
|
-
For security-sensitive work,
|
|
81
|
+
For security-sensitive work, include in the change explanation after coding:
|
|
82
82
|
|
|
83
83
|
- security-sensitive files or behavior changed
|
|
84
84
|
- tests or checks run
|
package/templates/TESTING.md
CHANGED
package/templates/WORKFLOWS.md
CHANGED
|
@@ -2,95 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
## Purpose
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Optional process reference for repositories that installed the **full** AgentKit template set.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
`AGENTS.md` is the canonical source of truth for daily agent work. Use this file only when you need a quick map of which companion guide fits a situation.
|
|
8
8
|
|
|
9
9
|
## Choose The Right Document
|
|
10
10
|
|
|
11
11
|
| Situation | Use |
|
|
12
12
|
| --- | --- |
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
17
|
-
|
|
|
18
|
-
|
|
|
19
|
-
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
1. Confirm the research question and scope.
|
|
26
|
-
2. Inspect relevant code, docs, tests, and history.
|
|
27
|
-
3. Use external sources only when current ecosystem knowledge is needed.
|
|
28
|
-
4. Separate facts from recommendations.
|
|
29
|
-
5. Summarize trade-offs, risks, and a recommended path.
|
|
30
|
-
6. Do not edit files unless the task changes from research to implementation.
|
|
31
|
-
|
|
32
|
-
## Planning Workflow
|
|
33
|
-
|
|
34
|
-
Use a PRD for product or user-facing work that needs intent, requirements, and acceptance criteria.
|
|
35
|
-
|
|
36
|
-
Use an implementation brief for engineering work that is already understood but needs a clear execution plan.
|
|
37
|
-
|
|
38
|
-
Tiny fixes can skip formal planning when the change is obvious and low risk.
|
|
39
|
-
|
|
40
|
-
## Branch Workflow
|
|
41
|
-
|
|
42
|
-
- Prefer an issue-linked branch when available.
|
|
43
|
-
- Use short, descriptive branch names:
|
|
44
|
-
- `feature/[short-name]`
|
|
45
|
-
- `fix/[short-name]`
|
|
46
|
-
- `chore/[short-name]`
|
|
47
|
-
- Keep each branch focused on one coherent change.
|
|
48
|
-
|
|
49
|
-
## Implementation Workflow
|
|
50
|
-
|
|
51
|
-
1. Read the issue, PRD, or implementation brief.
|
|
52
|
-
2. Inspect existing patterns and nearby tests.
|
|
53
|
-
3. Read relevant companion guidance from `AGENTS.md`.
|
|
54
|
-
4. Make the smallest complete change.
|
|
55
|
-
5. Add or update tests where behavior changes.
|
|
56
|
-
6. Run relevant checks.
|
|
57
|
-
7. Review the diff before handoff.
|
|
58
|
-
8. Explain the change using `CHANGE-EXPLANATION.md` when present.
|
|
59
|
-
|
|
60
|
-
## Pause And Ask Triggers
|
|
61
|
-
|
|
62
|
-
Pause and ask before:
|
|
63
|
-
|
|
64
|
-
- expanding scope beyond the request
|
|
65
|
-
- adding dependencies
|
|
66
|
-
- changing schemas or migrations
|
|
67
|
-
- changing auth, permissions, privacy, billing, or data retention behavior
|
|
68
|
-
- running destructive commands
|
|
69
|
-
- changing design tokens, themes, or foundational layout rules
|
|
70
|
-
- performing broad refactors or formatting-only rewrites
|
|
71
|
-
- removing tests or weakening validation
|
|
72
|
-
|
|
73
|
-
## Review Workflow
|
|
74
|
-
|
|
75
|
-
Review for correctness first, then maintainability, tests, UX, security, and style.
|
|
76
|
-
|
|
77
|
-
Call out:
|
|
78
|
-
|
|
79
|
-
- bugs or regressions
|
|
80
|
-
- missing validation or error handling
|
|
81
|
-
- missing authorization checks
|
|
82
|
-
- overly broad abstractions
|
|
83
|
-
- missing tests for changed behavior
|
|
84
|
-
- UI states that are missing or inaccessible
|
|
85
|
-
- unclear handoff, risks, or rollout notes
|
|
86
|
-
|
|
87
|
-
## Release Workflow
|
|
88
|
-
|
|
89
|
-
Before release:
|
|
90
|
-
|
|
91
|
-
- Confirm tests and build pass.
|
|
92
|
-
- Confirm docs match behavior.
|
|
93
|
-
- Confirm environment variables and migrations are documented.
|
|
94
|
-
- Confirm no secrets or local-only files are included.
|
|
95
|
-
- Confirm changelog or release notes are updated when the project expects them.
|
|
96
|
-
- Confirm rollback or mitigation steps for risky changes.
|
|
13
|
+
| Daily implementation, approval boundaries, change explanations | `AGENTS.md` |
|
|
14
|
+
| Tiny obvious fix | Implement directly; no formal planning doc |
|
|
15
|
+
| User-facing feature or product uncertainty (planning requested) | Create from `PRD-TEMPLATE.md` under `[briefs path, e.g. docs/briefs]` |
|
|
16
|
+
| Multi-file engineering with risk (planning requested) | Create from `IMPLEMENTATION-BRIEF-TEMPLATE.md` under `[briefs path, e.g. docs/briefs]` |
|
|
17
|
+
| UI, styling, layout, navigation, components | `DESIGN-SYSTEM.md` or project design-system path |
|
|
18
|
+
| Security-sensitive change | `SECURITY-CHECKLIST.md` if present |
|
|
19
|
+
| Test strategy or test implementation | `TESTING.md` if present |
|
|
20
|
+
| Review, refactor, dependencies | `CODE-QUALITY.md` |
|
|
21
|
+
| Any task that edits repository files | Change-explanation format in `AGENTS.md` and `CHANGE-EXPLANATION.md` |
|
|
22
|
+
|
|
23
|
+
For branching, implementation steps, review expectations, and release checks, follow `AGENTS.md`.
|