mirror of
https://github.com/kuhyx/testsAndMisc.git
synced 2026-11-19 22:18:25 +01:00
Twelve prose violations to zero. Eight files split into per-topic subdirectories with the original left as an index; both SKILL.md files keep their frontmatter so discovery still works, with detail moved to references/. Deleted docs/cleanup-2026-05/ (7 files) and linux_configuration/docs/ VERIFICATION.md on the user's ruling: unreferenced records of finished work whose rules are now enforced by the polling, shellcheck and shfmt hooks. PACMAN_WRAPPER_SECURITY.md was split instead - unlike those, it documents live guarantees. Every split verified by a sorted diff against HEAD: zero content lines lost, only the new headings and index links added. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011w2Pj4Ek3ZNMQVYcFHgXDY
92 lines
2.7 KiB
Markdown
92 lines
2.7 KiB
Markdown
# The review process and multi-model pattern
|
|
|
|
## Review Process
|
|
|
|
### Step 1: Understand the Context
|
|
|
|
Before looking at code, understand the intent:
|
|
|
|
```
|
|
- What is this change trying to accomplish?
|
|
- What spec or task does it implement?
|
|
- What is the expected behavior change?
|
|
```
|
|
|
|
### Step 2: Review the Tests First
|
|
|
|
Tests reveal intent and coverage:
|
|
|
|
```
|
|
- Do tests exist for the change?
|
|
- Do they test behavior (not implementation details)?
|
|
- Are edge cases covered?
|
|
- Do tests have descriptive names?
|
|
- Would the tests catch a regression if the code changed?
|
|
```
|
|
|
|
### Step 3: Review the Implementation
|
|
|
|
Walk through the code with the five axes in mind:
|
|
|
|
```
|
|
For each file changed:
|
|
1. Correctness: Does this code do what the test says it should?
|
|
2. Readability: Can I understand this without help?
|
|
3. Architecture: Does this fit the system?
|
|
4. Security: Any vulnerabilities?
|
|
5. Performance: Any bottlenecks?
|
|
```
|
|
|
|
### Step 4: Categorize Findings
|
|
|
|
Label every comment with its severity so the author knows what's required vs optional:
|
|
|
|
| Prefix | Meaning | Author Action |
|
|
| ----------------------------- | ------------------ | ------------------------------------------------------- |
|
|
| _(no prefix)_ | Required change | Must address before merge |
|
|
| **Critical:** | Blocks merge | Security vulnerability, data loss, broken functionality |
|
|
| **Nit:** | Minor, optional | Author may ignore — formatting, style preferences |
|
|
| **Optional:** / **Consider:** | Suggestion | Worth considering but not required |
|
|
| **FYI** | Informational only | No action needed — context for future reference |
|
|
|
|
This prevents authors from treating all feedback as mandatory and wasting time on optional suggestions.
|
|
|
|
### Step 5: Verify the Verification
|
|
|
|
Check the author's verification story:
|
|
|
|
```
|
|
- What tests were run?
|
|
- Did the build pass?
|
|
- Was the change tested manually?
|
|
- Are there screenshots for UI changes?
|
|
- Is there a before/after comparison?
|
|
```
|
|
|
|
## Multi-Model Review Pattern
|
|
|
|
Use different models for different review perspectives:
|
|
|
|
```
|
|
Model A writes the code
|
|
│
|
|
▼
|
|
Model B reviews for correctness and architecture
|
|
│
|
|
▼
|
|
Model A addresses the feedback
|
|
│
|
|
▼
|
|
Human makes the final call
|
|
```
|
|
|
|
This catches issues that a single model might miss — different models have different blind spots.
|
|
|
|
**Example prompt for a review agent:**
|
|
|
|
```
|
|
Review this code change for correctness, security, and adherence to
|
|
our project conventions. The spec says [X]. The change should [Y].
|
|
Flag any issues as Critical, Important, or Suggestion.
|
|
```
|