procedure-cli 0.2.4 → 1.0.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/package.json +1 -1
- package/templates/AGENTS.md.hbs +21 -0
- package/templates/CLAUDE.md.hbs +9 -0
package/package.json
CHANGED
package/templates/AGENTS.md.hbs
CHANGED
|
@@ -28,6 +28,27 @@ Run typecheck before build. Run all checks before submitting a PR.
|
|
|
28
28
|
|
|
29
29
|
{{{architecture}}}
|
|
30
30
|
|
|
31
|
+
## Review & Fix Setup
|
|
32
|
+
|
|
33
|
+
- During Setup, enable review skills to install `/b3awesome-code-review` and `/b3awesome-code-fix`.
|
|
34
|
+
- Setup should also seed `CODE-REVIEW.md`, `CODE-FIXED.md`, and `scripts/archive-reviews.sh` at project root.
|
|
35
|
+
- Keep review and fix as separate processes; never do both in one pass.
|
|
36
|
+
|
|
37
|
+
## Review/Fix Procedure
|
|
38
|
+
|
|
39
|
+
1. **Code Review pass**
|
|
40
|
+
- Read `CODE-REVIEW.md` first, then `CODE-FIXED.md`.
|
|
41
|
+
- Inspect codebase and append a new `CR-YYYYMMDD-###` entry to `CODE-REVIEW.md`.
|
|
42
|
+
- Do not change code and do not write to `CODE-FIXED.md`.
|
|
43
|
+
2. **Code Fix pass**
|
|
44
|
+
- Read `CODE-REVIEW.md` first, then `CODE-FIXED.md`.
|
|
45
|
+
- Fix only `New`/`Still Open` findings from the latest review.
|
|
46
|
+
- Append a new `CF-YYYYMMDD-###` entry to `CODE-FIXED.md`.
|
|
47
|
+
- Do not write to `CODE-REVIEW.md`.
|
|
48
|
+
3. **Archive pass**
|
|
49
|
+
- If logs get large and latest review has no open findings, run `scripts/archive-reviews.sh`.
|
|
50
|
+
- Script writes history into `CODE-REVIEW.archive.md` and `CODE-FIXED.archive.md`, then resets active logs to headers.
|
|
51
|
+
|
|
31
52
|
## Testing
|
|
32
53
|
|
|
33
54
|
1. Run `{{typecheckCommand}}` — must pass with no errors
|
package/templates/CLAUDE.md.hbs
CHANGED
|
@@ -89,6 +89,11 @@ Two tracking files live at the project root. Both are append-only logs — never
|
|
|
89
89
|
- Deferred findings include rationale and a revisit trigger.
|
|
90
90
|
- Verification section must confirm `{{typecheckCommand}}` + `{{buildCommand}}` status after fixes.
|
|
91
91
|
|
|
92
|
+
### Setup Assets
|
|
93
|
+
- Setup step can seed `CODE-REVIEW.md`, `CODE-FIXED.md`, and `scripts/archive-reviews.sh`.
|
|
94
|
+
- Setup step can also install reusable skills: `/b3awesome-code-review` and `/b3awesome-code-fix`.
|
|
95
|
+
- If these files are missing in a generated project, re-run setup or copy from `templates/skills/`.
|
|
96
|
+
|
|
92
97
|
### Procedure
|
|
93
98
|
1. **Reviewing**:
|
|
94
99
|
- **First**: Read CODE-REVIEW.md → Read CODE-FIXED.md → understand current state of findings and fixes.
|
|
@@ -98,6 +103,10 @@ Two tracking files live at the project root. Both are append-only logs — never
|
|
|
98
103
|
- **First**: Read CODE-REVIEW.md → Read CODE-FIXED.md → identify unfixed findings.
|
|
99
104
|
- **Then**: Fix only unfixed findings → append a new `CF-` entry to CODE-FIXED.md (write to CODE-FIXED.md only, never modify CODE-REVIEW.md).
|
|
100
105
|
- **Never** perform a code review during a fixing process.
|
|
106
|
+
3. **Archiving**:
|
|
107
|
+
- When review/fix logs become large and latest review has 0 open findings, run `scripts/archive-reviews.sh`.
|
|
108
|
+
- The script appends resolved entries into `CODE-REVIEW.archive.md` and `CODE-FIXED.archive.md`, then keeps only headers in active logs.
|
|
109
|
+
- Do not archive while active unresolved findings still exist.
|
|
101
110
|
|
|
102
111
|
## Release
|
|
103
112
|
|