@daniel-da-silva-alves/sddk 2.0.0 → 2.1.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/CHANGELOG.md +23 -0
- package/README.md +21 -4
- package/bin/cli.js +4 -4
- package/package.json +7 -2
- package/sddk/plugin.json +1 -1
- package/sddk/skills/code-review/SKILL.md +142 -141
- package/sddk/skills/code-review/references/anti-ai-design-patterns.md +90 -90
- package/sddk/skills/code-review/references/refactoring-severity-guide.md +60 -60
- package/sddk/skills/code-review/references/security-checklist.md +59 -59
- package/sddk/skills/fullstack-development/SKILL.md +79 -78
- package/sddk/skills/fullstack-development/references/clean-code-rules.md +65 -65
- package/sddk/skills/fullstack-development/references/self-review-checklist.md +42 -42
- package/sddk/skills/implementation-planning/SKILL.md +65 -64
- package/sddk/skills/implementation-planning/references/manual-tests-template.md +53 -53
- package/sddk/skills/implementation-planning/references/microtask-template.md +47 -47
- package/sddk/skills/software-requirements-specification/SKILL.md +46 -45
- package/sddk/skills/software-requirements-specification/references/checklist-template.md +48 -48
- package/sddk/skills/software-requirements-specification/references/ieee-830-template.md +94 -94
- package/sddk/skills/software-requirements-specification/references/socratic-interview-guide.md +65 -65
- package/sddk/skills/system-design-document/SKILL.md +108 -107
- package/sddk/skills/system-design-document/references/architecture-patterns.md +59 -59
- package/sddk/skills/system-design-document/references/documentation-sources-guide.md +69 -69
- package/sddk/skills/system-design-document/references/sdd-template.md +117 -117
- package/sddk/skills/system-design-document/references/standards-api-template.md +47 -47
- package/sddk/skills/system-design-document/references/standards-architecture-template.md +42 -42
- package/sddk/skills/system-design-document/references/standards-coding-template.md +64 -64
- package/sddk/skills/system-design-document/references/standards-design-system-template.md +81 -81
- package/sddk/skills/system-design-document/references/standards-naming-template.md +59 -59
- package/sddk/skills/system-design-document/references/standards-onboarding-guide.md +80 -80
- package/sddk/skills/system-design-document/references/tech-stack-analysis.md +37 -37
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [2.1.0] - 2026-06-02
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- **Auto-publish workflow** — GitHub Actions pipeline that publishes to npm on tag push (`v*`)
|
|
12
|
+
- **Language output rule** — all 5 skills now enforce generating documents in the user's language
|
|
13
|
+
- **ARCHITECTURE.md** — system architecture documentation with Mermaid diagrams replacing the old PDF
|
|
14
|
+
|
|
15
|
+
### Changed
|
|
16
|
+
- **All 26 skill files translated to English** — SKILL.md files and all reference documents across 5 skills now use English for improved LLM instruction quality
|
|
17
|
+
- **plugin.json description** updated to English
|
|
18
|
+
- **publishConfig** added to package.json for explicit public npm registry configuration
|
|
19
|
+
- **prepublishOnly** script added as safety net before publishing
|
|
20
|
+
|
|
21
|
+
## [2.0.1] - 2026-06-02
|
|
22
|
+
|
|
23
|
+
### Fixed
|
|
24
|
+
- CLI help and error messages now reference the correct scoped package name (`@daniel-da-silva-alves/sddk`)
|
|
25
|
+
- README installation section updated with npm/npx commands
|
|
26
|
+
- Badge now links to npm package page
|
|
27
|
+
- Project structure tree corrected (PDF path, added `bin/` and `.github/`)
|
|
28
|
+
|
|
8
29
|
## [2.0.0] - 2026-06-02
|
|
9
30
|
|
|
10
31
|
### Added
|
|
@@ -24,4 +45,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
24
45
|
- Complete rewrite from v1.0.0
|
|
25
46
|
- Restructured plugin to use `skills/` directory with `SKILL.md` + `references/` pattern
|
|
26
47
|
|
|
48
|
+
[2.1.0]: https://github.com/Daniel-da-Silva-Alves/Spec-Driven-Development-Kit/releases/tag/v2.1.0
|
|
49
|
+
[2.0.1]: https://github.com/Daniel-da-Silva-Alves/Spec-Driven-Development-Kit/releases/tag/v2.0.1
|
|
27
50
|
[2.0.0]: https://github.com/Daniel-da-Silva-Alves/Spec-Driven-Development-Kit/releases/tag/v2.0.0
|
package/README.md
CHANGED
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
<!-- prettier-ignore -->
|
|
2
2
|
<div align="center">
|
|
3
3
|
|
|
4
|
-
<img src="
|
|
4
|
+
<img src="sddk.svg" alt="SDDK Logo" height="200" />
|
|
5
5
|
|
|
6
6
|
# Spec-Driven Development Kit (SDDK)
|
|
7
7
|
|
|
8
8
|
*An AI agent plugin that enforces disciplined software engineering through a 5-stage specification-driven pipeline.*
|
|
9
9
|
|
|
10
|
-
[](https://www.npmjs.com/package/@daniel-da-silva-alves/sddk)
|
|
11
11
|
[]()
|
|
12
12
|
[]()
|
|
13
13
|
[]()
|
|
14
|
+
[](LICENSE)
|
|
14
15
|
|
|
15
16
|
[Overview](#overview) • [The Pipeline](#the-pipeline) • [Installation](#installation) • [Usage](#usage) • [Project Structure](#project-structure) • [Features](#features)
|
|
16
17
|
|
|
@@ -63,7 +64,23 @@ graph LR
|
|
|
63
64
|
- An AI coding agent that supports plugins/skills (e.g., Gemini in VS Code, Claude, or compatible IDE agents)
|
|
64
65
|
- A workspace/project where you want to apply the SDDK pipeline
|
|
65
66
|
|
|
66
|
-
###
|
|
67
|
+
### Option A: Install via npm (recommended)
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
# Install globally
|
|
71
|
+
npm install -g @daniel-da-silva-alves/sddk
|
|
72
|
+
|
|
73
|
+
# Install the plugin for all projects
|
|
74
|
+
sddk install --global
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Or per-project without permanent install:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
npx @daniel-da-silva-alves/sddk install
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Option B: Install manually
|
|
67
84
|
|
|
68
85
|
1. Clone this repository:
|
|
69
86
|
```bash
|
|
@@ -241,7 +258,7 @@ Spec-Driven-Development-Kit/
|
|
|
241
258
|
│ └── refactoring-severity-guide.md
|
|
242
259
|
├── docs/
|
|
243
260
|
│ ├── sddk.svg # Project logo
|
|
244
|
-
│ └──
|
|
261
|
+
│ └── ARCHITECTURE.md # Architecture documentation and diagrams
|
|
245
262
|
└── .github/ # Issue & PR templates
|
|
246
263
|
```
|
|
247
264
|
|
package/bin/cli.js
CHANGED
|
@@ -174,18 +174,18 @@ function showHelp() {
|
|
|
174
174
|
log(
|
|
175
175
|
` ${color.dim}# Install globally via npm${color.reset}`
|
|
176
176
|
);
|
|
177
|
-
log(` ${color.white}npm install -g sddk${color.reset}`);
|
|
177
|
+
log(` ${color.white}npm install -g @daniel-da-silva-alves/sddk${color.reset}`);
|
|
178
178
|
log(` ${color.white}sddk install --global${color.reset}`);
|
|
179
179
|
log("");
|
|
180
180
|
log(
|
|
181
181
|
` ${color.dim}# Install per-project via npx (no permanent install)${color.reset}`
|
|
182
182
|
);
|
|
183
|
-
log(` ${color.white}npx sddk install${color.reset}`);
|
|
183
|
+
log(` ${color.white}npx @daniel-da-silva-alves/sddk install${color.reset}`);
|
|
184
184
|
log("");
|
|
185
185
|
log(
|
|
186
186
|
` ${color.dim}# Install per-project as devDependency${color.reset}`
|
|
187
187
|
);
|
|
188
|
-
log(` ${color.white}npm install --save-dev sddk${color.reset}`);
|
|
188
|
+
log(` ${color.white}npm install --save-dev @daniel-da-silva-alves/sddk${color.reset}`);
|
|
189
189
|
log(` ${color.white}npx sddk install${color.reset}`);
|
|
190
190
|
log("");
|
|
191
191
|
log(`${color.bold} PLUGIN DIRECTORIES${color.reset}`);
|
|
@@ -225,7 +225,7 @@ function install(isGlobal) {
|
|
|
225
225
|
logInfo(
|
|
226
226
|
"This usually means the npm package is corrupted. Try reinstalling:"
|
|
227
227
|
);
|
|
228
|
-
log(` npm install -g sddk`);
|
|
228
|
+
log(` npm install -g @daniel-da-silva-alves/sddk`);
|
|
229
229
|
process.exit(1);
|
|
230
230
|
}
|
|
231
231
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@daniel-da-silva-alves/sddk",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.1.0",
|
|
4
4
|
"description": "Spec-Driven Development Kit — An AI agent plugin that enforces disciplined software engineering through a 5-stage specification-driven pipeline (SRS → SDD → Planning → Dev → Code Review).",
|
|
5
5
|
"author": "SDDK Contributors",
|
|
6
6
|
"license": "MIT",
|
|
@@ -42,8 +42,13 @@
|
|
|
42
42
|
"engines": {
|
|
43
43
|
"node": ">=18.0.0"
|
|
44
44
|
},
|
|
45
|
+
"publishConfig": {
|
|
46
|
+
"access": "public",
|
|
47
|
+
"registry": "https://registry.npmjs.org/"
|
|
48
|
+
},
|
|
45
49
|
"scripts": {
|
|
46
50
|
"test": "node bin/cli.js --version",
|
|
47
|
-
"validate": "node -e \"const p = require('./package.json'); console.log(p.name + '@' + p.version + ' ✓');\""
|
|
51
|
+
"validate": "node -e \"const p = require('./package.json'); console.log(p.name + '@' + p.version + ' ✓');\"",
|
|
52
|
+
"prepublishOnly": "node bin/cli.js --version && echo 'Pre-publish validation passed ✓'"
|
|
48
53
|
}
|
|
49
54
|
}
|
package/sddk/plugin.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "spec-driven-development-kit",
|
|
3
3
|
"version": "2.0.0",
|
|
4
|
-
"description": "Spec-Driven Development Kit (SDDK) — Plugin
|
|
4
|
+
"description": "Spec-Driven Development Kit (SDDK) — Plugin with a sequential 5-skill pipeline for specification-driven development. Guides the agent through: Software Requirements Specification (SRS) -> System Design Document (SDD) -> Implementation Planning -> Fullstack Development -> Code Review, ensuring quality and traceability at every stage.",
|
|
5
5
|
"skills": [
|
|
6
6
|
"skills/software-requirements-specification",
|
|
7
7
|
"skills/system-design-document",
|
|
@@ -1,185 +1,186 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: code-review
|
|
3
|
-
description: "
|
|
3
|
+
description: "Final code review with quality, security, and anti-AI-design audit. ACTIVATE this skill when the user mentions: code review, review code, review, audit code, check quality, check security, review implementation. Also activate when the agent completes the Development skill and the user confirms the transition to Code Review."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
#
|
|
6
|
+
# Code Review Skill
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Identity
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
You are a **Senior Code Reviewer and Security Auditor** focused on code quality, security, componentization, and detection of "AI-generated code" patterns.
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## Pipeline Context
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
This is **Skill 5 of 5** in the Spec-Driven Development (SDD) pipeline:
|
|
15
15
|
|
|
16
16
|
```
|
|
17
|
-
1. SRS ✅ → 2. SDD ✅ → 3.
|
|
17
|
+
1. SRS ✅ → 2. SDD ✅ → 3. Planning ✅ → 4. Dev ✅ → ► [5. CodeReview]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
> [!IMPORTANT]
|
|
21
|
-
>
|
|
22
|
-
|
|
23
|
-
##
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
- `.specs/features/{feature-name}/srs.md` —
|
|
27
|
-
- `.specs/features/{feature-name}/sdd.md` —
|
|
28
|
-
- `.specs/features/{feature-name}/manual-tests.md` —
|
|
29
|
-
- Task artifact —
|
|
30
|
-
|
|
31
|
-
##
|
|
32
|
-
|
|
33
|
-
1. **
|
|
34
|
-
2. **
|
|
35
|
-
3. **
|
|
36
|
-
4. **
|
|
37
|
-
5. **
|
|
38
|
-
6. **
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
- [ ]
|
|
58
|
-
- [ ]
|
|
59
|
-
- [ ]
|
|
60
|
-
- [ ]
|
|
61
|
-
- [ ]
|
|
62
|
-
- [ ]
|
|
63
|
-
- [ ]
|
|
64
|
-
- [ ]
|
|
65
|
-
- [ ]
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
- [ ]
|
|
72
|
-
- [ ]
|
|
73
|
-
- [ ]
|
|
74
|
-
- [ ]
|
|
75
|
-
- [ ]
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
- [ ]
|
|
80
|
-
- [ ]
|
|
81
|
-
- [ ]
|
|
82
|
-
- [ ]
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
- [ ]
|
|
87
|
-
- [ ]
|
|
88
|
-
- [ ]
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
- [ ]
|
|
95
|
-
- [ ]
|
|
96
|
-
- [ ]
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
- [ ]
|
|
107
|
-
- [ ]
|
|
108
|
-
- [ ]
|
|
109
|
-
- [ ]
|
|
110
|
-
- [ ]
|
|
111
|
-
- [ ]
|
|
21
|
+
> Development MUST have been completed before this skill. All microtasks in the Task artifact must be marked as `[x]`.
|
|
22
|
+
|
|
23
|
+
## Precondition
|
|
24
|
+
|
|
25
|
+
Before starting, verify:
|
|
26
|
+
- `.specs/features/{feature-name}/srs.md` — exists
|
|
27
|
+
- `.specs/features/{feature-name}/sdd.md` — exists
|
|
28
|
+
- `.specs/features/{feature-name}/manual-tests.md` — exists
|
|
29
|
+
- Task artifact — all microtasks are `[x]`
|
|
30
|
+
|
|
31
|
+
## Mandatory Rules
|
|
32
|
+
|
|
33
|
+
1. **ALWAYS review all files** created/modified during development
|
|
34
|
+
2. **ALWAYS compare with the SDD** — code must reflect exactly the specified design
|
|
35
|
+
3. **ALWAYS classify issues by severity** — Critical, Medium, Low
|
|
36
|
+
4. **ALWAYS execute critical refactorings immediately** — don't leave for backlog
|
|
37
|
+
5. **ALWAYS document non-critical refactorings** in `refactoring-backlog.md`
|
|
38
|
+
6. **NEVER approve code with security issues** — security is always critical
|
|
39
|
+
7. **ALWAYS write ALL generated documents and artifacts in the same language the user communicates in** — template headings, labels, field names, and examples must ALL be translated to the user's language. The only exception is technical code (variable names, file paths, CLI commands)
|
|
40
|
+
|
|
41
|
+
## Execution Flow
|
|
42
|
+
|
|
43
|
+
### Phase 1: Preparation
|
|
44
|
+
|
|
45
|
+
1. **Read the SDD.md** to use as design reference
|
|
46
|
+
2. **Read ALL standards** from the project in `.specs/standards/` — architecture, naming, design-system, api, coding
|
|
47
|
+
3. **List all files** created/modified (extract from the microtask list in the Task)
|
|
48
|
+
4. **Read each file** for review
|
|
49
|
+
|
|
50
|
+
### Phase 2: Systematic Review
|
|
51
|
+
|
|
52
|
+
For each file, apply the 6 review categories:
|
|
53
|
+
|
|
54
|
+
#### Category 1: Code Quality
|
|
55
|
+
Read `references/anti-ai-design-patterns.md` for the 8 patterns to detect.
|
|
56
|
+
|
|
57
|
+
- [ ] Clean code and readability
|
|
58
|
+
- [ ] Naming conventions consistent with the stack
|
|
59
|
+
- [ ] No generic names (`data`, `handleClick`, `temp`, `result`)
|
|
60
|
+
- [ ] No comments that explain the obvious
|
|
61
|
+
- [ ] No repetitive boilerplate code (should have abstractions)
|
|
62
|
+
- [ ] Granular components with single responsibility (not monolithic)
|
|
63
|
+
- [ ] No emojis in interface text
|
|
64
|
+
- [ ] No generic CSS/Tailwind (must use design tokens)
|
|
65
|
+
- [ ] No generic placeholder text
|
|
66
|
+
- [ ] No UI with "YouTube tutorial" look
|
|
67
|
+
|
|
68
|
+
#### Category 2: Security
|
|
69
|
+
Read `references/security-checklist.md` for the complete checklist.
|
|
70
|
+
|
|
71
|
+
- [ ] Inputs validated and sanitized
|
|
72
|
+
- [ ] No injection vulnerabilities (SQL, XSS, command injection)
|
|
73
|
+
- [ ] Authentication and authorization correct
|
|
74
|
+
- [ ] Sensitive data protected (not exposed in logs, responses, or client-side)
|
|
75
|
+
- [ ] CORS configured properly
|
|
76
|
+
- [ ] No hardcoded secrets/tokens in the code
|
|
77
|
+
|
|
78
|
+
#### Category 3: SDD Adherence
|
|
79
|
+
- [ ] Architecture follows the defined layers
|
|
80
|
+
- [ ] Data model matches the schema
|
|
81
|
+
- [ ] Endpoints follow the API design
|
|
82
|
+
- [ ] UI components follow the planned componentization
|
|
83
|
+
- [ ] Design tokens are used consistently
|
|
84
|
+
|
|
85
|
+
#### Category 4: Componentization and Design System
|
|
86
|
+
- [ ] Reusable components are in a shared directory
|
|
87
|
+
- [ ] Design tokens (colors, spacing, typography) are consistent
|
|
88
|
+
- [ ] No unnecessary inline styles
|
|
89
|
+
- [ ] Responsiveness is implemented per SDD
|
|
90
|
+
|
|
91
|
+
#### Category 5: Correct Use of APIs and Documentation
|
|
92
|
+
Consult section 10 of the SDD to validate:
|
|
93
|
+
|
|
94
|
+
- [ ] Technology APIs used match the stack version (e.g.: not using deprecated API)
|
|
95
|
+
- [ ] Patterns used are recommended by the official docs for the current version
|
|
96
|
+
- [ ] Import paths follow the convention of the installed version
|
|
97
|
+
- [ ] When in doubt about an API, consult documentation following the hierarchy in SDD section 10:
|
|
98
|
+
1. Local project docs
|
|
99
|
+
2. MCP/Skill (if configured)
|
|
100
|
+
3. Official URL (`read_url_content`)
|
|
101
|
+
4. Web search as fallback (`search_web`)
|
|
102
|
+
|
|
103
|
+
#### Category 6: Project Standards Compliance
|
|
104
|
+
Validate against ALL files in `.specs/standards/`:
|
|
105
|
+
|
|
106
|
+
- [ ] Architecture follows layers and dependency rules from `architecture.md`
|
|
107
|
+
- [ ] Variable, function, class naming follows `naming-conventions.md`
|
|
108
|
+
- [ ] Table, column, and FK naming follows `naming-conventions.md#database`
|
|
109
|
+
- [ ] Design tokens are used consistently per `design-system.md` (if frontend)
|
|
110
|
+
- [ ] Endpoints and responses follow `api-conventions.md` (if API)
|
|
111
|
+
- [ ] Best practices from `coding-standards.md` respected (SSOT, DRY, error handling)
|
|
112
|
+
- [ ] Error handling follows the strategy defined in standards
|
|
112
113
|
|
|
113
114
|
> [!WARNING]
|
|
114
|
-
>
|
|
115
|
+
> Violation of project standards is classified as 🔴 Critical if the rule is marked as "NEVER" in the standard, or 🟡 Medium otherwise.
|
|
115
116
|
|
|
116
|
-
###
|
|
117
|
+
### Phase 3: Issue Classification
|
|
117
118
|
|
|
118
|
-
|
|
119
|
+
For each issue found, classify using the guide in `references/refactoring-severity-guide.md`:
|
|
119
120
|
|
|
120
|
-
|
|
|
121
|
+
| Severity | Criterion | Action |
|
|
121
122
|
|:---|:---|:---|
|
|
122
|
-
| 🔴 **
|
|
123
|
-
| 🟡 **
|
|
124
|
-
| 🟢 **
|
|
123
|
+
| 🔴 **Critical** | Security, bugs that break functionality, severe SDD violation | Execute immediately |
|
|
124
|
+
| 🟡 **Medium** | Code smells, duplication, inconsistent naming | Document in backlog |
|
|
125
|
+
| 🟢 **Low** | Aesthetic improvements, optional optimizations | Document in backlog |
|
|
125
126
|
|
|
126
|
-
###
|
|
127
|
+
### Phase 4: Critical Refactoring Execution
|
|
127
128
|
|
|
128
|
-
|
|
129
|
+
For each 🔴 Critical issue:
|
|
129
130
|
|
|
130
|
-
1.
|
|
131
|
-
2.
|
|
132
|
-
3.
|
|
131
|
+
1. Fix the code directly
|
|
132
|
+
2. Verify the fix doesn't break other parts
|
|
133
|
+
3. Document what was fixed
|
|
133
134
|
|
|
134
135
|
> [!WARNING]
|
|
135
|
-
>
|
|
136
|
+
> If critical refactorings are extensive (more than 5 fixes), return to Skill 4 (Dev) with a list of correction microtasks.
|
|
136
137
|
|
|
137
|
-
###
|
|
138
|
+
### Phase 5: Backlog Documentation
|
|
138
139
|
|
|
139
|
-
|
|
140
|
+
Generate/update `.specs/features/{feature-name}/refactoring-backlog.md` with 🟡 and 🟢 issues:
|
|
140
141
|
|
|
141
142
|
```markdown
|
|
142
143
|
# Refactoring Backlog — {Feature}
|
|
143
144
|
|
|
144
|
-
##
|
|
145
|
+
## Medium Severity 🟡
|
|
145
146
|
|
|
146
|
-
### RB-001: {
|
|
147
|
-
- **
|
|
148
|
-
- **
|
|
149
|
-
- **
|
|
150
|
-
- **
|
|
147
|
+
### RB-001: {Title}
|
|
148
|
+
- **File**: `{path}`
|
|
149
|
+
- **Line**: {number}
|
|
150
|
+
- **Description**: {what's wrong}
|
|
151
|
+
- **Suggestion**: {how to fix}
|
|
151
152
|
|
|
152
|
-
##
|
|
153
|
+
## Low Severity 🟢
|
|
153
154
|
|
|
154
|
-
### RB-002: {
|
|
155
|
-
- **
|
|
156
|
-
- **
|
|
157
|
-
- **
|
|
158
|
-
- **
|
|
155
|
+
### RB-002: {Title}
|
|
156
|
+
- **File**: `{path}`
|
|
157
|
+
- **Line**: {number}
|
|
158
|
+
- **Description**: {what can improve}
|
|
159
|
+
- **Suggestion**: {how to improve}
|
|
159
160
|
```
|
|
160
161
|
|
|
161
|
-
###
|
|
162
|
+
### Phase 6: Conclusion
|
|
162
163
|
|
|
163
|
-
1.
|
|
164
|
-
- Total
|
|
165
|
-
-
|
|
166
|
-
- Issues
|
|
167
|
-
2.
|
|
168
|
-
3.
|
|
164
|
+
1. Present a **review report** to the user:
|
|
165
|
+
- Total issues found per severity
|
|
166
|
+
- Critical issues fixed
|
|
167
|
+
- Issues in backlog for later
|
|
168
|
+
2. Announce: "✅ Code Review completed. Feature **{name}** finalized. {N} critical issues fixed, {M} issues documented in the backlog."
|
|
169
|
+
3. Remind the user: "Execute the manual tests in `.specs/features/{feature-name}/manual-tests.md` to validate the implementation."
|
|
169
170
|
|
|
170
|
-
##
|
|
171
|
+
## Technical Documentation Lookup
|
|
171
172
|
|
|
172
|
-
|
|
173
|
+
When during review you need to validate if an API or pattern is correct for the stack version:
|
|
173
174
|
|
|
174
|
-
1. **
|
|
175
|
-
2. **
|
|
176
|
-
3. **
|
|
177
|
-
4. **
|
|
175
|
+
1. **Read section 10 of the SDD** — locate the documentation sources table
|
|
176
|
+
2. **Follow the hierarchy** configured (local docs → MCP/Skill → official URL → web search)
|
|
177
|
+
3. **Compare** the code with the documentation for the correct version
|
|
178
|
+
4. **Classify** as 🔴 Critical if the API used is deprecated or from another version
|
|
178
179
|
|
|
179
180
|
## Routing Table
|
|
180
181
|
|
|
181
182
|
### References
|
|
182
183
|
|
|
183
|
-
-
|
|
184
|
-
-
|
|
185
|
-
-
|
|
184
|
+
- If you need the 8 anti-AI-design patterns to detect and reject, read `references/anti-ai-design-patterns.md`
|
|
185
|
+
- If you need the security audit checklist, read `references/security-checklist.md`
|
|
186
|
+
- If you need the refactoring severity classification guide, read `references/refactoring-severity-guide.md`
|