anyone-can-architect 0.2.0 → 0.4.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/CONTEXT.md +2 -2
- package/README.md +6 -4
- package/README.zh-CN.md +4 -2
- package/SSOT.md +5 -0
- package/VERSION +1 -1
- package/axioms/README.md +1 -1
- package/axioms/writing.md +3 -1
- package/dist/antigravity/aca/SKILL.md +3 -2
- package/dist/antigravity/aca-design/SKILL.md +12 -6
- package/dist/antigravity/aca-implement/SKILL.md +102 -114
- package/dist/antigravity/aca-release/SKILL.md +13 -20
- package/dist/antigravity/aca-repo-audit/SKILL.md +13 -9
- package/dist/antigravity/aca-review/SKILL.md +146 -182
- package/dist/antigravity/aca-test/SKILL.md +112 -0
- package/dist/antigravity/aca-walkthrough/SKILL.md +18 -14
- package/dist/antigravity-cli/aca/SKILL.md +3 -2
- package/dist/antigravity-cli/aca-design/SKILL.md +12 -6
- package/dist/antigravity-cli/aca-implement/SKILL.md +102 -114
- package/dist/antigravity-cli/aca-release/SKILL.md +13 -20
- package/dist/antigravity-cli/aca-repo-audit/SKILL.md +13 -9
- package/dist/antigravity-cli/aca-review/SKILL.md +146 -182
- package/dist/antigravity-cli/aca-test/SKILL.md +112 -0
- package/dist/antigravity-cli/aca-walkthrough/SKILL.md +18 -14
- package/dist/codex/aca/SKILL.md +3 -2
- package/dist/codex/aca-design/SKILL.md +12 -6
- package/dist/codex/aca-implement/SKILL.md +102 -114
- package/dist/codex/aca-release/SKILL.md +13 -20
- package/dist/codex/aca-repo-audit/SKILL.md +13 -9
- package/dist/codex/aca-review/SKILL.md +146 -182
- package/dist/codex/aca-test/SKILL.md +112 -0
- package/dist/codex/aca-walkthrough/SKILL.md +18 -14
- package/dist/cursor/aca/SKILL.md +3 -2
- package/dist/cursor/aca-design/SKILL.md +12 -6
- package/dist/cursor/aca-implement/SKILL.md +102 -114
- package/dist/cursor/aca-release/SKILL.md +13 -20
- package/dist/cursor/aca-repo-audit/SKILL.md +13 -9
- package/dist/cursor/aca-review/SKILL.md +146 -182
- package/dist/cursor/aca-test/SKILL.md +113 -0
- package/dist/cursor/aca-walkthrough/SKILL.md +18 -14
- package/dist/grok/aca/SKILL.md +3 -2
- package/dist/grok/aca-design/SKILL.md +12 -6
- package/dist/grok/aca-implement/SKILL.md +102 -114
- package/dist/grok/aca-release/SKILL.md +13 -20
- package/dist/grok/aca-repo-audit/SKILL.md +13 -9
- package/dist/grok/aca-review/SKILL.md +146 -182
- package/dist/grok/aca-test/SKILL.md +112 -0
- package/dist/grok/aca-walkthrough/SKILL.md +18 -14
- package/doc-design/document-sets/module.md +6 -2
- package/doc-design/document-sets/ops-guide.md +25 -27
- package/doc-design/documents/class-design.md +7 -4
- package/doc-design/documents/instrumentation.md +3 -2
- package/doc-design/documents/integration-guide.md +7 -5
- package/doc-design/documents/interaction.md +516 -143
- package/doc-design/documents/interface.md +12 -7
- package/doc-design/documents/release.md +137 -105
- package/doc-design/patterns/interface.md +135 -14
- package/doc-design/repo-types/client-sdk.md +3 -3
- package/doc-design/repo-types/web-app.md +11 -5
- package/meta-skills/aca/SKILL.md +3 -2
- package/meta-skills/aca/SKILL.md.tmpl +3 -2
- package/package.json +1 -1
- package/skills/aca-design/SKILL.md +12 -6
- package/skills/aca-design/SKILL.md.tmpl +9 -5
- package/skills/aca-implement/SKILL.md +102 -114
- package/skills/aca-implement/SKILL.md.tmpl +103 -115
- package/skills/aca-release/SKILL.md +13 -20
- package/skills/aca-release/SKILL.md.tmpl +13 -20
- package/skills/aca-repo-audit/SKILL.md +13 -9
- package/skills/aca-repo-audit/SKILL.md.tmpl +10 -8
- package/skills/aca-review/SKILL.md +146 -182
- package/skills/aca-review/SKILL.md.tmpl +143 -181
- package/skills/aca-test/SKILL.md +112 -0
- package/skills/aca-test/SKILL.md.tmpl +110 -0
- package/skills/aca-walkthrough/SKILL.md +18 -14
- package/skills/aca-walkthrough/SKILL.md.tmpl +15 -13
- package/zh-CN/CONTEXT.md +2 -2
- package/zh-CN/SSOT.md +5 -0
- package/zh-CN/axioms/README.md +1 -1
- package/zh-CN/axioms/writing.md +3 -1
- package/zh-CN/dist/antigravity/aca/SKILL.md +3 -2
- package/zh-CN/dist/antigravity/aca-design/SKILL.md +12 -6
- package/zh-CN/dist/antigravity/aca-implement/SKILL.md +102 -114
- package/zh-CN/dist/antigravity/aca-release/SKILL.md +71 -69
- package/zh-CN/dist/antigravity/aca-repo-audit/SKILL.md +39 -29
- package/zh-CN/dist/antigravity/aca-review/SKILL.md +143 -179
- package/zh-CN/dist/antigravity/aca-test/SKILL.md +112 -0
- package/zh-CN/dist/antigravity/aca-walkthrough/SKILL.md +18 -14
- package/zh-CN/dist/antigravity-cli/aca/SKILL.md +3 -2
- package/zh-CN/dist/antigravity-cli/aca-design/SKILL.md +12 -6
- package/zh-CN/dist/antigravity-cli/aca-implement/SKILL.md +102 -114
- package/zh-CN/dist/antigravity-cli/aca-release/SKILL.md +71 -69
- package/zh-CN/dist/antigravity-cli/aca-repo-audit/SKILL.md +39 -29
- package/zh-CN/dist/antigravity-cli/aca-review/SKILL.md +143 -179
- package/zh-CN/dist/antigravity-cli/aca-test/SKILL.md +112 -0
- package/zh-CN/dist/antigravity-cli/aca-walkthrough/SKILL.md +18 -14
- package/zh-CN/dist/codex/aca/SKILL.md +3 -2
- package/zh-CN/dist/codex/aca-design/SKILL.md +12 -6
- package/zh-CN/dist/codex/aca-implement/SKILL.md +102 -114
- package/zh-CN/dist/codex/aca-release/SKILL.md +71 -69
- package/zh-CN/dist/codex/aca-repo-audit/SKILL.md +39 -29
- package/zh-CN/dist/codex/aca-review/SKILL.md +143 -179
- package/zh-CN/dist/codex/aca-test/SKILL.md +112 -0
- package/zh-CN/dist/codex/aca-walkthrough/SKILL.md +18 -14
- package/zh-CN/dist/cursor/aca/SKILL.md +3 -2
- package/zh-CN/dist/cursor/aca-design/SKILL.md +12 -6
- package/zh-CN/dist/cursor/aca-implement/SKILL.md +102 -114
- package/zh-CN/dist/cursor/aca-release/SKILL.md +71 -69
- package/zh-CN/dist/cursor/aca-repo-audit/SKILL.md +39 -29
- package/zh-CN/dist/cursor/aca-review/SKILL.md +143 -179
- package/zh-CN/dist/cursor/aca-test/SKILL.md +113 -0
- package/zh-CN/dist/cursor/aca-walkthrough/SKILL.md +18 -14
- package/zh-CN/dist/grok/aca/SKILL.md +3 -2
- package/zh-CN/dist/grok/aca-design/SKILL.md +12 -6
- package/zh-CN/dist/grok/aca-implement/SKILL.md +102 -114
- package/zh-CN/dist/grok/aca-release/SKILL.md +71 -69
- package/zh-CN/dist/grok/aca-repo-audit/SKILL.md +39 -29
- package/zh-CN/dist/grok/aca-review/SKILL.md +143 -179
- package/zh-CN/dist/grok/aca-test/SKILL.md +112 -0
- package/zh-CN/dist/grok/aca-walkthrough/SKILL.md +18 -14
- package/zh-CN/doc-design/document-sets/module.md +6 -2
- package/zh-CN/doc-design/document-sets/ops-guide.md +25 -27
- package/zh-CN/doc-design/documents/class-design.md +7 -4
- package/zh-CN/doc-design/documents/instrumentation.md +3 -2
- package/zh-CN/doc-design/documents/integration-guide.md +7 -5
- package/zh-CN/doc-design/documents/interaction.md +516 -143
- package/zh-CN/doc-design/documents/interface.md +12 -7
- package/zh-CN/doc-design/documents/release.md +138 -106
- package/zh-CN/doc-design/patterns/interface.md +135 -14
- package/zh-CN/doc-design/repo-types/client-sdk.md +3 -3
- package/zh-CN/doc-design/repo-types/web-app.md +11 -5
- package/zh-CN/meta-skills/aca/SKILL.md +3 -2
- package/zh-CN/meta-skills/aca/SKILL.md.tmpl +3 -2
- package/zh-CN/skills/aca-design/SKILL.md +12 -6
- package/zh-CN/skills/aca-design/SKILL.md.tmpl +9 -5
- package/zh-CN/skills/aca-implement/SKILL.md +102 -114
- package/zh-CN/skills/aca-implement/SKILL.md.tmpl +102 -114
- package/zh-CN/skills/aca-release/SKILL.md +71 -69
- package/zh-CN/skills/aca-release/SKILL.md.tmpl +71 -69
- package/zh-CN/skills/aca-repo-audit/SKILL.md +39 -29
- package/zh-CN/skills/aca-repo-audit/SKILL.md.tmpl +36 -28
- package/zh-CN/skills/aca-review/SKILL.md +143 -179
- package/zh-CN/skills/aca-review/SKILL.md.tmpl +140 -178
- package/zh-CN/skills/aca-test/SKILL.md +112 -0
- package/zh-CN/skills/aca-test/SKILL.md.tmpl +110 -0
- package/zh-CN/skills/aca-walkthrough/SKILL.md +18 -14
- package/zh-CN/skills/aca-walkthrough/SKILL.md.tmpl +15 -13
|
@@ -34,7 +34,7 @@ Use `/aca-review` when you need to judge whether business goals and design solut
|
|
|
34
34
|
- Present the whole first, then expand on the details, see the [Pyramid Principle](~/.gemini/config/skills/aca/SSOT.md#2-structure)
|
|
35
35
|
- When stating a judgment, give the conclusion first, then the supporting evidence
|
|
36
36
|
- Merge heading levels that add no information
|
|
37
|
-
- Use numbered lists for items with a sequence or priority, and indent
|
|
37
|
+
- Use numbered lists for items with a sequence or priority; when a step contains sub-items, start the step with a bold phrase stating its purpose and indent specific operations and conditional branches under it
|
|
38
38
|
- Use tables only for content with multiple rows of the same structure, more than two attributes per row, and no sequence between rows
|
|
39
39
|
- Write list items as complete sentences
|
|
40
40
|
- When an item has branches, indent the branches under that item
|
|
@@ -53,6 +53,8 @@ Use `/aca-review` when you need to judge whether business goals and design solut
|
|
|
53
53
|
- Remove content that adds no information and does not help understanding
|
|
54
54
|
- Write one sentence per line, with only one fact per sentence
|
|
55
55
|
- State actions directly in operational steps
|
|
56
|
+
- If a specific practice fully expresses a constraint, write the practice directly
|
|
57
|
+
- Keep prohibitions that no specific practice can fully express
|
|
56
58
|
- Write sequential actions as separate items
|
|
57
59
|
- Make the actor, the object of the action, and the referents clear
|
|
58
60
|
- Do not repeat actors, objects of actions, or referents already clear from context
|
|
@@ -181,16 +183,17 @@ When an implementation audit is included, cross-check all design items in scope
|
|
|
181
183
|
|
|
182
184
|
### 5.2 Runtime Verification
|
|
183
185
|
|
|
184
|
-
1. Determine verification requirements
|
|
185
|
-
|
|
186
|
+
1. **Determine verification requirements**
|
|
187
|
+
Determine the test and build commands required for the current scope according to the boundary rules in `/aca-test` and the repository `release` doc
|
|
188
|
+
Run full tests and builds by default when the repository does not specify tiered verification
|
|
186
189
|
Check the required environment, configuration, and fixtures
|
|
187
|
-
2. Run verification or reuse its results
|
|
188
|
-
Reuse existing results if they cover the required
|
|
190
|
+
2. **Run verification or reuse its results**
|
|
191
|
+
Reuse existing `/aca-test` or build results if they cover the required scope and the commit under review, tests, fixtures, configuration, dependency environment, and commands have not changed
|
|
189
192
|
State the original verification results and the basis for reuse in the report
|
|
190
|
-
Run the
|
|
193
|
+
Run the required tests and builds in an isolated environment following the execution rules of `/aca-test` if the reuse conditions are not met
|
|
191
194
|
Static reading cannot replace verification by execution
|
|
192
195
|
Do not modify project source code, design docs, or commit history during verification
|
|
193
|
-
3. Record results and handle exceptions
|
|
196
|
+
3. **Record results and handle exceptions**
|
|
194
197
|
Record the results and supporting evidence when verification passes
|
|
195
198
|
Verify diagnostics and record confirmed issues when verification fails
|
|
196
199
|
Mark the corresponding verification as incomplete and explain why if the environment is unavailable or execution is not possible
|
|
@@ -223,7 +226,7 @@ When an implementation audit is included, cross-check all design items in scope
|
|
|
223
226
|
| Incomplete | Pass conditions are not met, and no confirmed must fix items exist |
|
|
224
227
|
|
|
225
228
|
Required checks include reading documentation, mechanical checks, and content checks in the current scope
|
|
226
|
-
When an implementation audit is included, they also include all consistency cross-checks
|
|
229
|
+
When an implementation audit is included, they also include all consistency cross-checks and the tests and builds required for the current scope
|
|
227
230
|
When both must fix items and incomplete checks exist, set the verdict to action required and list the incomplete items
|
|
228
231
|
Optional trim does not affect a pass
|
|
229
232
|
|
|
@@ -273,7 +276,8 @@ Choose one immediately executable action based on the nature of the issues and t
|
|
|
273
276
|
| Verification prerequisites are missing | Meet the prerequisites, then continue this audit through `/aca-repo-audit` |
|
|
274
277
|
| The solution still needs reasoning | Use `/aca-specify` to reason through the solution |
|
|
275
278
|
| The revised solution is clear and only docs need changes | Use `/aca-design` to revise the docs |
|
|
276
|
-
| Implementation deviates |
|
|
279
|
+
| Implementation deviates | `/aca-implement` Fix code or tests |
|
|
280
|
+
| Tests or builds incomplete | `/aca-test` Run verification |
|
|
277
281
|
| Audit passes | Return to the caller and continue with the confirmed arrangements |
|
|
278
282
|
|
|
279
283
|
Audit the affected scope again after the issues are corrected
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: aca-review
|
|
3
|
-
description: Review the design docs or code
|
|
3
|
+
description: Review the design docs or code structure in the current scope, determine pass, needs changes, or incomplete, and do not modify the docs or code under review
|
|
4
4
|
---
|
|
5
5
|
<!-- AUTO-GENERATED from SKILL.md.tmpl — do not edit directly -->
|
|
6
6
|
<!-- Regenerate: bash scripts/build-skills.sh --host antigravity -->
|
|
7
7
|
|
|
8
8
|
# aca-review
|
|
9
9
|
|
|
10
|
-
Review the design docs or code
|
|
11
|
-
Do not modify design docs, project source code, or test code
|
|
10
|
+
Review the design docs or code structure in the current scope and determine pass, needs changes, or incomplete
|
|
11
|
+
Do not modify design docs, project source code, or test code, and do not run the code or tests under review
|
|
12
12
|
Use `/aca-repo-audit` for the repository-wide audit before release
|
|
13
13
|
|
|
14
14
|
## 1 Principles
|
|
@@ -17,11 +17,11 @@ Use `/aca-repo-audit` for the repository-wide audit before release
|
|
|
17
17
|
|
|
18
18
|
1. **Source-driven review**
|
|
19
19
|
Review the design against confirmed requirements and applicable rules
|
|
20
|
-
Review the
|
|
20
|
+
Review the modularity and overall structure of the code against the confirmed design
|
|
21
21
|
2. **Independent judgment**
|
|
22
|
-
Form conclusions independently for each review
|
|
22
|
+
Form conclusions independently for each review dimension
|
|
23
23
|
3. **Evidence-based verdict**
|
|
24
|
-
Determine issues and review conclusions from
|
|
24
|
+
Determine issues and review conclusions from facts in the code structure and docs
|
|
25
25
|
4. **Scope constraints**
|
|
26
26
|
Limit review conclusions to the current scope
|
|
27
27
|
|
|
@@ -36,7 +36,7 @@ The writing axiom applies to reviews of design doc prose and the wording of revi
|
|
|
36
36
|
- Present the whole first, then expand on the details, see the [Pyramid Principle](~/.gemini/config/skills/aca/SSOT.md#2-structure)
|
|
37
37
|
- When stating a judgment, give the conclusion first, then the supporting evidence
|
|
38
38
|
- Merge heading levels that add no information
|
|
39
|
-
- Use numbered lists for items with a sequence or priority, and indent
|
|
39
|
+
- Use numbered lists for items with a sequence or priority; when a step contains sub-items, start the step with a bold phrase stating its purpose and indent specific operations and conditional branches under it
|
|
40
40
|
- Use tables only for content with multiple rows of the same structure, more than two attributes per row, and no sequence between rows
|
|
41
41
|
- Write list items as complete sentences
|
|
42
42
|
- When an item has branches, indent the branches under that item
|
|
@@ -55,6 +55,8 @@ The writing axiom applies to reviews of design doc prose and the wording of revi
|
|
|
55
55
|
- Remove content that adds no information and does not help understanding
|
|
56
56
|
- Write one sentence per line, with only one fact per sentence
|
|
57
57
|
- State actions directly in operational steps
|
|
58
|
+
- If a specific practice fully expresses a constraint, write the practice directly
|
|
59
|
+
- Keep prohibitions that no specific practice can fully express
|
|
58
60
|
- Write sequential actions as separate items
|
|
59
61
|
- Make the actor, the object of the action, and the referents clear
|
|
60
62
|
- Do not repeat actors, objects of actions, or referents already clear from context
|
|
@@ -80,12 +82,12 @@ Reference: [ASD-STE100](~/.gemini/config/skills/aca/SSOT.md#1-writing-rules)
|
|
|
80
82
|
```mermaid
|
|
81
83
|
flowchart TD
|
|
82
84
|
Start([Receive review request]) --> Scope["Confirm review scope and execution models · §3"]
|
|
83
|
-
Scope --> Check["Determine review type and
|
|
84
|
-
Check --> Audit["
|
|
85
|
-
Audit --> Verify["Recheck and
|
|
86
|
-
Verify --> Issues{"Confirmed must-fix items exist · §
|
|
87
|
-
Issues -- Yes, needs changes --> Report(["Output and next step · §
|
|
88
|
-
Issues -- No --> Complete{"All pass criteria are met · §
|
|
85
|
+
Scope --> Check["Determine review type and prepare sources · §4"]
|
|
86
|
+
Check --> Audit["Run independent reviews by review type · §5"]
|
|
87
|
+
Audit --> Verify["Recheck and determine the verdict · §6"]
|
|
88
|
+
Verify --> Issues{"Confirmed must-fix items exist · §6.2"}
|
|
89
|
+
Issues -- Yes, needs changes --> Report(["Output and next step · §7"])
|
|
90
|
+
Issues -- No --> Complete{"All pass criteria are met · §6.2"}
|
|
89
91
|
Complete -- Yes, pass --> Report
|
|
90
92
|
Complete -- No, incomplete --> Report
|
|
91
93
|
```
|
|
@@ -94,81 +96,72 @@ flowchart TD
|
|
|
94
96
|
|
|
95
97
|
### 3.1 Subject, Scope, and Prerequisites
|
|
96
98
|
|
|
97
|
-
1.
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
Read
|
|
115
|
-
Read the design docs for the current scope and follow references to read any additional docs needed for understanding and verification
|
|
99
|
+
1. **Confirm the review subject and scope**
|
|
100
|
+
- Developer has specified the review subject and scope: follow that specification first
|
|
101
|
+
- Developer has not specified them: use the review subject and scope already specified by the caller
|
|
102
|
+
- Subject or scope is still unclear: determine it from current workspace changes and recent relevant commits, reading the descriptions and diffs of recent relevant commits
|
|
103
|
+
- Review subject or scope still cannot be determined: ask the developer to specify it
|
|
104
|
+
2. **Record the comparison baseline**
|
|
105
|
+
- Record the review subject, scope, and comparison baseline
|
|
106
|
+
- Specify the commits under review and any uncommitted changes included in the review
|
|
107
|
+
3. **Check the repo type**
|
|
108
|
+
- Run `bash ~/.gemini/config/skills/aca/bin/aca-repo-type-check` to check the repo type
|
|
109
|
+
- Repo type is missing or invalid: mark the repo-type spec check as incomplete and recommend running `/aca-init`
|
|
110
|
+
- Repo type is not yet supported: mark the repo-type spec check as incomplete and note that the corresponding rules are missing
|
|
111
|
+
4. **Locate and read general review sources**
|
|
112
|
+
- When the input does not include the design doc location, locate it from the documentation entry in the root README, or ask the developer for its location if it cannot be located and mark checks that depend on this content as incomplete until the location is clear
|
|
113
|
+
- Read the confirmed problems, goals, and change scope for this review
|
|
114
|
+
- If the repo type is valid and supported, read the corresponding Repo Type rules
|
|
115
|
+
- Read `CONTEXT.md` and check the business concepts and definitions involved in this review
|
|
116
|
+
- Read the design docs for the current scope and follow references to read any additional docs needed for understanding and verification
|
|
116
117
|
|
|
117
118
|
### 3.2 Agent and Model Selection
|
|
118
119
|
|
|
119
|
-
1.
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
If
|
|
129
|
-
|
|
130
|
-
Explain the recommendation and available alternative combinations, and ask the developer to confirm
|
|
131
|
-
Run the review only after the developer confirms
|
|
132
|
-
Reuse the existing confirmation if the confirmed selection and availability conditions have not changed
|
|
133
|
-
4. Use the confirmed execution combinations for [task orchestration](#53-model-and-task-orchestration)
|
|
134
|
-
If the selected combination cannot be invoked, use a confirmed alternative
|
|
135
|
-
If no alternative has been confirmed, report the change and ask the developer to confirm a new combination
|
|
136
|
-
Record the actual selection, fallback, and reasons in the report
|
|
120
|
+
1. **Reuse the confirmed model first**
|
|
121
|
+
- Developer has specified an Agent environment or model: run with that specification
|
|
122
|
+
- A review model has already been confirmed and its availability conditions have not changed: reuse the last confirmed Agent environment and model by default, and skip the environment scan and confirmation
|
|
123
|
+
2. **Scan and confirm the model on the first review**
|
|
124
|
+
- On the first review with no model specified, scan the current AI Agent environment and other AI Agent environments on this machine, and the models that can be invoked
|
|
125
|
+
- Prefer recommending a callable flagship model that differs from the main agent; if no other suitable and callable candidate is available, propose using the current model
|
|
126
|
+
- Show each candidate's Agent environment, model, availability, and the reason for the recommendation, and ask the developer to confirm before running the review; later reviews reuse this confirmation by default
|
|
127
|
+
3. **Handle execution fallback**
|
|
128
|
+
- Use the confirmed or reused execution combination for [Task Orchestration and Execution](#53-task-orchestration-and-execution)
|
|
129
|
+
- If the selected combination cannot be invoked, use a confirmed alternative, or report the change and ask the developer to confirm a new combination if no alternative has been confirmed
|
|
130
|
+
- Record the Agent environment and model actually used, whether they were reused, and the reasons for any fallback in the [Review Report](#71-review-report)
|
|
137
131
|
|
|
138
132
|
## 4 Read Source Material and Run Checks
|
|
139
133
|
|
|
140
134
|
```mermaid
|
|
141
135
|
flowchart TD
|
|
142
|
-
Kind["Determine review type · §4.1"] -- Design review --> Design["Design review · §4.2"]
|
|
143
|
-
Kind -- Implementation review --> Implementation["Implementation review · §4.3"]
|
|
144
|
-
Design -->
|
|
145
|
-
Implementation -->
|
|
136
|
+
Kind["Determine review type · §4.1"] -- Design review --> Design["Design review preparation and mechanical checks · §4.2"]
|
|
137
|
+
Kind -- Implementation review --> Implementation["Implementation review source preparation · §4.3"]
|
|
138
|
+
Design --> Next(["Proceed to independent review · §5"])
|
|
139
|
+
Implementation --> Next
|
|
146
140
|
```
|
|
147
141
|
|
|
148
142
|
### 4.1 Determine Review Type
|
|
149
143
|
|
|
150
|
-
1.
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
-
|
|
154
|
-
-
|
|
155
|
-
- Both design and implementation: run both review types separately
|
|
156
|
-
3. If the review type is still unclear, ask the developer to specify it
|
|
144
|
+
1. **Determine the review type for this run**
|
|
145
|
+
- Developer has specified the review type: follow that specification first
|
|
146
|
+
- Developer has not specified it: use the review type already specified by the caller
|
|
147
|
+
- Review type is not specified: determine it from the subject under review and the actual changes (run a design review for design docs, run an implementation review for code, and run both review types separately when both are involved)
|
|
148
|
+
- Review type still cannot be determined: ask the developer to specify it
|
|
157
149
|
|
|
158
|
-
Run both
|
|
150
|
+
Run both branches when both review types are selected
|
|
159
151
|
|
|
160
152
|
### 4.2 Design Review
|
|
161
153
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
154
|
+
By default, design review applies to cross-module design changes (involving multiple modules, the project-level architecture, the module division, or cross-module interfaces and collaboration contracts), or to a design review the developer explicitly requests
|
|
155
|
+
|
|
156
|
+
1. **Extract applicable checklist items**
|
|
157
|
+
- Read the document set, Doc Design, and Patterns actually used for the current scope
|
|
158
|
+
- Extract their applicable checklist items as the basis for verification in the design review
|
|
159
|
+
2. **Reuse or run mechanical checks**
|
|
160
|
+
- Existing mechanical check results from this session can be reused directly if they cover the same scope and the relevant files, check rules, and tools have not changed, stating the original results and the basis for reuse in the report
|
|
161
|
+
- If the reuse conditions are not met, replace the placeholder paths in the following commands with the actual paths of the docs under review and run them
|
|
162
|
+
- Prose checks cover all docs under review, including project-level records within the review scope
|
|
163
|
+
- For the doc graph check, select a doc tree that includes the docs under review and has a README entry
|
|
164
|
+
- Mechanical checks for Context verify structure and formatting
|
|
172
165
|
|
|
173
166
|
```bash
|
|
174
167
|
bash ~/.gemini/config/skills/aca/bin/aca-doc-graph-check <doc directory>
|
|
@@ -176,111 +169,94 @@ Run both check branches when both review types are selected
|
|
|
176
169
|
bash ~/.gemini/config/skills/aca/bin/aca-prose-check <paths to all docs under review>
|
|
177
170
|
```
|
|
178
171
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
1. Read the confirmed design, test design, and repository implementation conventions for the current scope
|
|
182
|
-
2. Read the current diff and changed files against the established comparison baseline
|
|
183
|
-
Read affected callers and dependency code
|
|
184
|
-
Read the functions, classes, and related call chains containing the changes to understand their execution context
|
|
185
|
-
3. Map the implementation and tests to the design conventions and test scenarios respectively
|
|
186
|
-
4. Based on the impact scope of the current changes, run or reuse the tests, builds, and static checks required by the design and repository conventions
|
|
187
|
-
Verify behavior that the design requires checking through actual execution by running the corresponding test cases
|
|
188
|
-
Existing verification results can be reused if they cover the same content under review and the test cases, fixtures, configuration, and dependency environment have not changed
|
|
189
|
-
When reusing results, state the original verification results and the reuse conditions met in this review in the report
|
|
190
|
-
Run the corresponding checks if verification evidence is insufficient or reuse conditions are not met
|
|
191
|
-
Use an isolated verification environment as specified by the test design
|
|
192
|
-
Do not modify commit history during verification
|
|
193
|
-
|
|
194
|
-
### 4.4 Handle Check Results
|
|
195
|
-
|
|
196
|
-
Handle tool checks for both review types as specified in this section
|
|
172
|
+
3. **Handle mechanical check results**
|
|
197
173
|
|
|
198
174
|
| Check status | Action |
|
|
199
175
|
| --- | --- |
|
|
200
|
-
| Pass | Record the results and verification evidence |
|
|
176
|
+
| Pass, or reuse conditions met | Record the results and the verification or reuse evidence |
|
|
201
177
|
| Failure returned | Check the diagnostics and list confirmed issues as must fix |
|
|
202
178
|
| Cannot run or diagnostics cannot be verified | Mark the corresponding check or issue verification as incomplete and state the reason |
|
|
203
179
|
|
|
180
|
+
### 4.3 Implementation Review
|
|
181
|
+
|
|
182
|
+
1. **Read the structural design and organization conventions**
|
|
183
|
+
- Read the architecture design, module boundaries, interface definitions, internal composition, and repository code organization conventions for the current scope
|
|
184
|
+
2. **Read the overall structure of the code under review**
|
|
185
|
+
- Against the established comparison baseline, read the directory and file distribution, module dependencies, function and class definitions, and cross-module assembly wiring involved in the changes
|
|
186
|
+
3. **Define the review boundary**
|
|
187
|
+
- By default, implementation review applies to cross-module changes or changes to a module's overall code structure (changes that stay inside a module and do not change its overall code structure skip implementation review and go directly to `/aca-test`)
|
|
188
|
+
- Implementation review checks only the overall structure (module structure, overall code distribution, and function construction), and does not check specific code details or implementation logic
|
|
189
|
+
- Implementation review does not run code, tests, or builds directly, and runtime verification is executed by `/aca-test` after the review passes
|
|
190
|
+
|
|
204
191
|
## 5 Review Orchestration and Execution
|
|
205
192
|
|
|
206
193
|
### 5.1 Design Review Dimensions
|
|
207
194
|
|
|
208
|
-
|
|
195
|
+
Design review is one overall review task that checks the design docs under review against the following four items
|
|
196
|
+
|
|
197
|
+
1. **Requirements and scope coverage**
|
|
209
198
|
Check whether the design fully addresses the confirmed problems, goals, and scope
|
|
210
|
-
2. **
|
|
211
|
-
Check whether the division of responsibilities and boundaries
|
|
212
|
-
Check whether the collaboration and processing mechanisms
|
|
213
|
-
If user interaction is involved, check whether
|
|
214
|
-
Check whether
|
|
215
|
-
3. **
|
|
216
|
-
Check whether module dependencies and interface conventions are sufficient to guide module collaboration
|
|
217
|
-
Check whether data, state changes, error handling, and boundary behavior are sufficient to guide detailed implementation
|
|
199
|
+
2. **Responsibility boundaries and collaboration mechanisms**
|
|
200
|
+
Check whether the division of responsibilities and boundaries, module dependencies, and interface conventions match the division of business work and are sufficient to guide module collaboration
|
|
201
|
+
Check whether the collaboration and processing mechanisms, data and state changes, error handling, and boundary behavior are sufficient to guide detailed implementation
|
|
202
|
+
If user interaction is involved, check whether the interaction flow, each interaction state, and each success and failure path provide clear feedback and action guidance
|
|
203
|
+
Check whether the design contains ambiguities that would lead to different business behavior, and whether additional design decisions are still needed before implementation
|
|
204
|
+
3. **Completeness of the verification design**
|
|
218
205
|
Check whether the test design specifies fixtures, scenarios, execution methods, and expected results
|
|
219
206
|
Check whether test results can determine if the corresponding acceptance criteria are met
|
|
220
|
-
|
|
221
|
-
Check whether additional design decisions are still needed before implementation
|
|
222
|
-
4. **Overall perspective**
|
|
207
|
+
4. **Cross-doc consistency and writing rules**
|
|
223
208
|
Check whether the documentation entry and references accurately locate the current design and its dependencies
|
|
224
209
|
Check related docs for design omissions, conflicting conventions, duplicate definitions, or inconsistent terminology
|
|
210
|
+
Check whether the checklist items of the applicable document set, Doc Design, and Patterns are met
|
|
225
211
|
|
|
226
212
|
### 5.2 Implementation Review Dimensions
|
|
227
213
|
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
1. **
|
|
231
|
-
Check whether the division of modules and
|
|
232
|
-
2. **
|
|
233
|
-
Check whether
|
|
234
|
-
|
|
235
|
-
Check whether
|
|
236
|
-
|
|
237
|
-
3
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
For implementation reviews, assign independent sub-agents to structural setup, detailed logic implementation, and overall structural implementation
|
|
246
|
-
Each sub-agent forms conclusions independently without reading other sub-agents' review results beforehand
|
|
247
|
-
2. Arrange execution using the combinations confirmed in [Agent and Model Selection](#32-agent-and-model-selection)
|
|
248
|
-
Keep review tasks independent even when using the current model
|
|
249
|
-
3. Provide task context to each sub-agent
|
|
250
|
-
- Assigned review items and applicable checklist items
|
|
214
|
+
Implementation review is one overall review task that uses the confirmed design docs as its basis, checks only the modularity and overall structure of the code, and does not check specific code details or implementation logic
|
|
215
|
+
|
|
216
|
+
1. **Module structure**
|
|
217
|
+
Check whether the division of modules and submodules, responsibility assignments, interface boundaries, dependencies, and cross-module assembly wiring conform to the design
|
|
218
|
+
2. **Overall code distribution**
|
|
219
|
+
Check whether the directory and file organization conforms to the design, whether each file has a single responsibility and clear ownership, and whether responsibilities are mixed or layers are coupled across boundaries
|
|
220
|
+
3. **Function construction**
|
|
221
|
+
Check whether the responsibility split, signature design, granularity, and level of abstraction of functions and classes are clear and reasonable
|
|
222
|
+
|
|
223
|
+
### 5.3 Task Orchestration and Execution
|
|
224
|
+
|
|
225
|
+
1. **Dispatch independent review tasks by review type**
|
|
226
|
+
- When only a design review or only an implementation review runs, create 1 independent sub-agent task to complete all check items of that dimension
|
|
227
|
+
- When both design and implementation reviews run, create 1 independent sub-agent task for the design review and 1 for the implementation review
|
|
228
|
+
- Run each review task according to [Agent and Model Selection](#32-agent-and-model-selection), and form conclusions independently
|
|
229
|
+
2. **Provide task context**
|
|
230
|
+
- The assigned review type, its check items, and applicable checklist items
|
|
251
231
|
- Review subject, scope, and comparison baseline, including commits under review and uncommitted changes included in the review
|
|
252
232
|
- Locations of the content under review and the corresponding design source material
|
|
253
|
-
-
|
|
254
|
-
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
Mark review items or checks that still cannot be completed as incomplete and state the reasons
|
|
277
|
-
4. Summarize confirmed issues and check completion status as the basis for the verdict
|
|
278
|
-
|
|
279
|
-
## 7 Verdict
|
|
233
|
+
- For design review, the mechanical check results and evidence from Chapter 4
|
|
234
|
+
- For implementation review, the directory and file structure, changed files, module dependencies, and repository code organization conventions
|
|
235
|
+
3. **Run an issue-oriented review**
|
|
236
|
+
- The sub-agent verifies each check item and applicable checklist item of its dimension
|
|
237
|
+
- When it finds an issue, it records the file location, problem, impact, and recommended change using the issue format in the [Review Report](#71-review-report)
|
|
238
|
+
- When a check item cannot be completed, it records the incomplete item and the reason
|
|
239
|
+
- Pass and not-applicable items are not itemized; the sub-agent returns the list of issues found, incomplete items, and its review conclusion to the main agent
|
|
240
|
+
|
|
241
|
+
## 6 Recheck and Verdict
|
|
242
|
+
|
|
243
|
+
### 6.1 Recheck and Merge
|
|
244
|
+
|
|
245
|
+
1. **Recheck issue evidence**
|
|
246
|
+
- The main agent checks the files and evidence for each issue returned by the sub-agents and includes it in the report only after confirming it
|
|
247
|
+
- Exclude disproven issues and mark issues with insufficient evidence as incomplete verification
|
|
248
|
+
- The main agent can add issues it finds independently after applying the same evidence verification
|
|
249
|
+
- Merge duplicate issues while retaining their locations, evidence, and impact
|
|
250
|
+
2. **Check review coverage**
|
|
251
|
+
- Confirm that the selected review dimensions and their check items have all been verified
|
|
252
|
+
- If a sub-agent did not cover its assigned scope or omitted check items, check the corresponding content and recheck the results
|
|
253
|
+
- Mark review dimensions or checks that still cannot be completed as incomplete and state the reasons
|
|
254
|
+
|
|
255
|
+
### 6.2 Verdict
|
|
280
256
|
|
|
281
257
|
| Verdict | Criteria |
|
|
282
258
|
| --- | --- |
|
|
283
|
-
| Pass | All selected review tasks are complete, all applicable checklist items have passed verification, all applicable
|
|
259
|
+
| Pass | All selected review tasks are complete, all applicable checklist items have passed verification, all applicable mechanical checks have passed, and there are no must-fix items |
|
|
284
260
|
| Needs changes | Confirmed must-fix items exist |
|
|
285
261
|
| Incomplete | Pass criteria are not met and there are no confirmed must-fix items |
|
|
286
262
|
|
|
@@ -288,9 +264,9 @@ If must-fix items and incomplete checks both exist, the verdict is needs changes
|
|
|
288
264
|
Optional improvements do not affect a pass
|
|
289
265
|
After the content under review changes, review the affected scope again and update the corresponding conclusions
|
|
290
266
|
|
|
291
|
-
##
|
|
267
|
+
## 7 Output and Next Step
|
|
292
268
|
|
|
293
|
-
###
|
|
269
|
+
### 7.1 Review Report
|
|
294
270
|
|
|
295
271
|
Output the review results in the current conversation using the following template without writing to project files
|
|
296
272
|
|
|
@@ -299,12 +275,13 @@ Output the review results in the current conversation using the following templa
|
|
|
299
275
|
|
|
300
276
|
| Item | Result |
|
|
301
277
|
| --- | --- |
|
|
302
|
-
| Subject | <design docs / code
|
|
278
|
+
| Subject | <design docs / code structure / both> |
|
|
303
279
|
| Scope | <modules, files, or changes under review> |
|
|
304
280
|
| Baseline | <comparison baseline, commits under review, and uncommitted changes> |
|
|
281
|
+
| Execution model | <Agent environment and model actually used, reuse status, and fallback reasons> |
|
|
305
282
|
| Verdict basis | <how pass criteria are met, or issues and incomplete checks preventing a pass> |
|
|
306
283
|
| Must fix | <issue count and main impact / none> |
|
|
307
|
-
| Tool checks | <pass, failure, and incomplete status of
|
|
284
|
+
| Tool checks | <pass, reuse, failure, and incomplete status of design review mechanical checks / not applicable for implementation review> |
|
|
308
285
|
| Incomplete | <incomplete review tasks and checks within the current scope, and reasons / none> |
|
|
309
286
|
| Next step | <one immediately actionable step> |
|
|
310
287
|
|
|
@@ -312,39 +289,26 @@ Output the review results in the current conversation using the following templa
|
|
|
312
289
|
|
|
313
290
|
- <doc section link / code file link and line number>
|
|
314
291
|
- Problem: <actual content, design conventions or checklist items violated, and specific deviations>
|
|
315
|
-
- Impact: <impact on design understanding, implementation, or
|
|
292
|
+
- Impact: <impact on design understanding, implementation, or maintenance of the code structure, and conditions under which it occurs>
|
|
316
293
|
- Change: <content to correct or confirm, and conventions or checklist items to satisfy after correction>
|
|
317
294
|
|
|
318
295
|
## Optional Improvements
|
|
319
296
|
|
|
320
297
|
- <suggested improvements that do not affect a pass, corresponding locations, and expected benefits>
|
|
321
|
-
|
|
322
|
-
## Check Scope
|
|
323
|
-
|
|
324
|
-
- Read: <files actually read in this review>
|
|
325
|
-
- Checklist: <criteria and sources, item-by-item verification results, basis for non-applicability, and reasons for incomplete checks>
|
|
326
|
-
- Tools: <commands actually run and their results, or original results reused and basis for reuse>
|
|
327
|
-
|
|
328
|
-
| Review item | Agent environment | Model | Completion status | Notes |
|
|
329
|
-
| --- | --- | --- | --- | --- |
|
|
330
|
-
| <design review perspective / implementation review item> | <actual Agent environment> | <actual model and verifiable version> | <complete / incomplete> | <reason for fallback or incomplete status / none> |
|
|
331
298
|
```
|
|
332
299
|
|
|
333
|
-
|
|
334
|
-
For implementation reviews, list the three items: structural setup, detailed logic implementation, and overall structural implementation
|
|
335
|
-
|
|
336
|
-
### 8.2 Follow-Up Actions
|
|
300
|
+
### 7.2 Follow-Up Actions
|
|
337
301
|
|
|
338
302
|
Select the next step based on the review verdict and progress in the current round
|
|
339
303
|
|
|
340
304
|
| Verdict | Situation | Next step |
|
|
341
305
|
| --- | --- | --- |
|
|
342
|
-
| Incomplete | Inputs
|
|
343
|
-
| Needs changes |
|
|
344
|
-
| Needs changes | The
|
|
345
|
-
| Needs changes |
|
|
346
|
-
| Pass |
|
|
347
|
-
| Pass |
|
|
348
|
-
| Pass |
|
|
349
|
-
|
|
350
|
-
After design or
|
|
306
|
+
| Incomplete | Inputs or verification conditions are missing | Report the conditions for resuming and continue this review through `/aca-review` once they are met |
|
|
307
|
+
| Needs changes | The design solution still needs reasoning or decisions | `/aca-specify` Extend or revise the solution |
|
|
308
|
+
| Needs changes | The solution is clear and only design docs need revision | `/aca-design` Revise the docs |
|
|
309
|
+
| Needs changes | Code structure issues | `/aca-implement` Adjust the code structure |
|
|
310
|
+
| Pass | Design review passed and code implementation is needed in this round | `/aca-implement` |
|
|
311
|
+
| Pass | Design review passed and only design docs are changed in this round | Proceed to `/aca-release` according to the confirmed version progression plan |
|
|
312
|
+
| Pass | Implementation review passed | `/aca-test` Run test verification for the current scope |
|
|
313
|
+
|
|
314
|
+
After design or code structure corrections, review the affected scope again through `/aca-review`
|