code-framework 1.0.0 → 1.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/README.md +99 -33
- package/_code/checklists/architecture-checklist.md +168 -0
- package/_code/checklists/brief-checklist.md +132 -0
- package/_code/checklists/code-review-checklist.md +211 -0
- package/_code/checklists/pre-release-checklist.md +248 -0
- package/_code/checklists/story-checklist.md +172 -0
- package/install.js +405 -103
- package/package.json +1 -1
- package/project-template/.claude/commands.yaml +228 -63
package/README.md
CHANGED
|
@@ -4,38 +4,58 @@
|
|
|
4
4
|
|
|
5
5
|
> "All ideas deserve a story."
|
|
6
6
|
|
|
7
|
-
CODE is an AI-assisted development framework that helps anyone - coders and non-coders alike - ship their ideas. It takes you from a simple idea to a living, evolving product through structured workflows and personality-driven AI agents.
|
|
7
|
+
CODE is an AI-assisted development framework that helps anyone - coders and non-coders alike - ship their ideas. It takes you from a simple idea to a living, evolving product through structured workflows, quality gates, and personality-driven AI agents.
|
|
8
8
|
|
|
9
9
|
## Quick Start
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
# Install CODE to your project
|
|
13
|
-
npx code-framework
|
|
13
|
+
npx code-framework
|
|
14
14
|
|
|
15
|
-
#
|
|
16
|
-
|
|
15
|
+
# Follow the interactive prompts to:
|
|
16
|
+
# 1. Select your AI CLI tools (Claude Code, Cursor, Windsurf, etc.)
|
|
17
|
+
# 2. Install framework files
|
|
18
|
+
# 3. Configure your chosen tools
|
|
17
19
|
```
|
|
18
20
|
|
|
21
|
+
## Supported AI CLI Tools
|
|
22
|
+
|
|
23
|
+
CODE Framework integrates with multiple AI coding assistants:
|
|
24
|
+
|
|
25
|
+
| Tool | Status | Config File |
|
|
26
|
+
|------|--------|-------------|
|
|
27
|
+
| **Claude Code** ⭐ | Recommended | `.claude/commands.yaml`, `CLAUDE.md` |
|
|
28
|
+
| **Cursor** ⭐ | Recommended | `.cursorrules` |
|
|
29
|
+
| **Windsurf** | Supported | `.windsurfrules` |
|
|
30
|
+
| **Antigravity** | Supported | `.antigravity/commands.yaml` |
|
|
31
|
+
| **OpenCode** | Supported | `.opencode/commands.yaml` |
|
|
32
|
+
| **Aider** | Supported | `CONVENTIONS.md` |
|
|
33
|
+
| **Cline** | Supported | `.clinerules` |
|
|
34
|
+
|
|
19
35
|
## The CODE Process
|
|
20
36
|
|
|
21
37
|
```
|
|
22
38
|
1. CONTEXT Fill out your BRIEF (5 simple docs)
|
|
23
|
-
↓
|
|
39
|
+
↓ └─ Quality Gate: /code-checklist-brief
|
|
24
40
|
2. OUTLINE AI generates technical architecture
|
|
25
|
-
↓
|
|
41
|
+
↓ └─ Quality Gate: /code-checklist-architecture
|
|
26
42
|
3. DOCUMENTATION AI creates Epics & Stories
|
|
27
|
-
↓
|
|
28
|
-
4.
|
|
43
|
+
↓ └─ Quality Gate: /code-checklist-story
|
|
44
|
+
4. IMPLEMENT Build story by story
|
|
45
|
+
↓ └─ Quality Gate: /code-checklist-code
|
|
46
|
+
5. EVOLVE Add features, repeat the cycle
|
|
47
|
+
└─ Quality Gate: /code-checklist-release
|
|
29
48
|
```
|
|
30
49
|
|
|
31
50
|
## Your Project Structure After Install
|
|
32
51
|
|
|
33
52
|
```
|
|
34
53
|
your-project/
|
|
35
|
-
├── _code/ # Framework (
|
|
54
|
+
├── _code/ # Framework (read-only)
|
|
36
55
|
│ ├── agents/ # AI agent personalities
|
|
37
56
|
│ ├── workflows/ # Guided processes
|
|
38
|
-
│
|
|
57
|
+
│ ├── templates/ # Output templates
|
|
58
|
+
│ └── checklists/ # Quality gates
|
|
39
59
|
│
|
|
40
60
|
├── 1-context/ # YOUR CONTEXT (start here!)
|
|
41
61
|
│ ├── v1.0.0/ # Version 1 of your idea
|
|
@@ -59,11 +79,7 @@ your-project/
|
|
|
59
79
|
│
|
|
60
80
|
├── 4-documentation/ # Living Plan
|
|
61
81
|
│ ├── epics/ # Epic files (growing list)
|
|
62
|
-
│ │ ├── epic-001-*.md
|
|
63
|
-
│ │ └── epic-002-*.md
|
|
64
82
|
│ └── stories/ # Story files by epic
|
|
65
|
-
│ ├── epic-001/
|
|
66
|
-
│ └── epic-002/
|
|
67
83
|
│
|
|
68
84
|
├── 5-evolution/ # Change tracking
|
|
69
85
|
│ └── changelog.md # What changed and when
|
|
@@ -75,35 +91,85 @@ your-project/
|
|
|
75
91
|
|
|
76
92
|
| Agent | Role | When to Call |
|
|
77
93
|
|-------|------|--------------|
|
|
78
|
-
| **SAGE** | Guide & Orchestrator | Start here, coordinates everything |
|
|
79
|
-
| **IRIS** | Context Architect | Helps fill out BRIEF |
|
|
80
|
-
| **ATLAS** | Technical Architect | Generates Outline |
|
|
81
|
-
| **LUNA** | Experience Designer | Creates UX & Wireframes |
|
|
82
|
-
| **ECHO** | Story Keeper | Writes Epics & Stories |
|
|
83
|
-
| **PHOENIX** | Evolution Strategist | Manages feature additions |
|
|
84
|
-
| **BUILDER** | Developer | Implements stories |
|
|
85
|
-
| **SCOUT** | Quality Guide | Reviews & tests |
|
|
94
|
+
| **SAGE** 🧙 | Guide & Orchestrator | Start here, coordinates everything |
|
|
95
|
+
| **IRIS** 🎯 | Context Architect | Helps fill out BRIEF |
|
|
96
|
+
| **ATLAS** 🏗️ | Technical Architect | Generates Outline |
|
|
97
|
+
| **LUNA** 🎨 | Experience Designer | Creates UX & Wireframes |
|
|
98
|
+
| **ECHO** 📖 | Story Keeper | Writes Epics & Stories |
|
|
99
|
+
| **PHOENIX** 🚀 | Evolution Strategist | Manages feature additions |
|
|
100
|
+
| **BUILDER** 💻 | Developer | Implements stories |
|
|
101
|
+
| **SCOUT** 🧪 | Quality Guide | Reviews & tests |
|
|
86
102
|
|
|
87
103
|
## Commands
|
|
88
104
|
|
|
105
|
+
All commands use the `/code-` prefix to avoid conflicts with other tools.
|
|
106
|
+
|
|
107
|
+
### Main Commands
|
|
108
|
+
|
|
109
|
+
| Command | Description |
|
|
110
|
+
|---------|-------------|
|
|
111
|
+
| `/code-help` | Show help and available commands |
|
|
112
|
+
| `/code-status` | Check project status and next steps |
|
|
113
|
+
| `/code-sage` | Start here - SAGE guides you through everything |
|
|
114
|
+
| `/code-brief` | Fill out or improve your BRIEF |
|
|
115
|
+
| `/code-outline` | Generate technical architecture from BRIEF |
|
|
116
|
+
| `/code-ux` | Generate sitemap and wireframe prompts |
|
|
117
|
+
| `/code-docs` | Generate epics and stories |
|
|
118
|
+
| `/code-implement` | Start coding a story |
|
|
119
|
+
| `/code-review` | Review and QA any work |
|
|
120
|
+
| `/code-evolve` | Add a new feature (creates new version) |
|
|
121
|
+
| `/code-party` | Bring all agents together for discussion |
|
|
122
|
+
|
|
123
|
+
### Quality Gate Commands
|
|
124
|
+
|
|
89
125
|
| Command | Description |
|
|
90
126
|
|---------|-------------|
|
|
91
|
-
| `/
|
|
92
|
-
| `/brief` |
|
|
93
|
-
| `/
|
|
94
|
-
| `/
|
|
95
|
-
| `/
|
|
96
|
-
| `/
|
|
97
|
-
|
|
98
|
-
|
|
127
|
+
| `/code-checklist` | Run a specific quality checklist |
|
|
128
|
+
| `/code-checklist-brief` | Validate BRIEF completeness |
|
|
129
|
+
| `/code-checklist-architecture` | Review technical architecture |
|
|
130
|
+
| `/code-checklist-story` | Validate story before implementation |
|
|
131
|
+
| `/code-checklist-code` | Code review checklist |
|
|
132
|
+
| `/code-checklist-release` | Pre-release verification |
|
|
133
|
+
|
|
134
|
+
### Utility Commands
|
|
135
|
+
|
|
136
|
+
| Command | Description |
|
|
137
|
+
|---------|-------------|
|
|
138
|
+
| `/code-research` | Research a topic and save findings |
|
|
139
|
+
| `/code-sprint` | Plan a sprint from available stories |
|
|
140
|
+
|
|
141
|
+
## Quality Gates
|
|
142
|
+
|
|
143
|
+
Each workflow has a corresponding quality checklist:
|
|
144
|
+
|
|
145
|
+
| Checklist | When to Use | Location |
|
|
146
|
+
|-----------|-------------|----------|
|
|
147
|
+
| Brief Checklist | After BRIEF, before Outline | `_code/checklists/brief-checklist.md` |
|
|
148
|
+
| Architecture Checklist | After Outline, before Docs | `_code/checklists/architecture-checklist.md` |
|
|
149
|
+
| Story Checklist | Before implementing a story | `_code/checklists/story-checklist.md` |
|
|
150
|
+
| Code Review Checklist | Before merging code | `_code/checklists/code-review-checklist.md` |
|
|
151
|
+
| Pre-Release Checklist | Before production deployment | `_code/checklists/pre-release-checklist.md` |
|
|
99
152
|
|
|
100
153
|
## Philosophy
|
|
101
154
|
|
|
102
155
|
1. **All ideas deserve a story** - Every feature, every thought gets documented
|
|
103
156
|
2. **AI-assisted, human-controlled** - AI suggests, you decide
|
|
104
|
-
3. **
|
|
105
|
-
4. **
|
|
106
|
-
5. **
|
|
157
|
+
3. **Quality gates matter** - Checklists prevent disasters before they happen
|
|
158
|
+
4. **Living documentation** - Your plan grows with your project
|
|
159
|
+
5. **Context isolation** - New features don't pollute old context
|
|
160
|
+
6. **Ship, don't dream** - Everything exists to help you launch
|
|
161
|
+
|
|
162
|
+
## Comparison with BMAD
|
|
163
|
+
|
|
164
|
+
CODE Framework is a streamlined alternative to the [BMAD Method](https://github.com/bmadcode/BMAD-METHOD):
|
|
165
|
+
|
|
166
|
+
| Aspect | BMAD | CODE |
|
|
167
|
+
|--------|------|------|
|
|
168
|
+
| Setup | CLI wizard with many options | Simple `npx` with tool selection |
|
|
169
|
+
| Structure | Role-based (personas, agents, tasks) | Version-based (v1.0.0 folders) |
|
|
170
|
+
| Commands | `/bmad-*` prefix | `/code-*` prefix |
|
|
171
|
+
| Quality Gates | Comprehensive checklists | 5 essential checklists |
|
|
172
|
+
| Best For | Enterprises, large teams | Solo devs, small teams, MVPs |
|
|
107
173
|
|
|
108
174
|
## License
|
|
109
175
|
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# Architecture Quality Checklist
|
|
2
|
+
|
|
3
|
+
**Purpose:** Validate technical architecture before generating epics and stories.
|
|
4
|
+
|
|
5
|
+
**When to run:** After completing the outline, before running `/code-docs`.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Technical Outline Completeness
|
|
10
|
+
|
|
11
|
+
### System Overview
|
|
12
|
+
- [ ] **High-level architecture** - Is there a clear system diagram/description?
|
|
13
|
+
- [ ] **Component breakdown** - Are major components identified?
|
|
14
|
+
- [ ] **Component responsibilities** - Is each component's purpose clear?
|
|
15
|
+
- [ ] **Data flow** - Is it clear how data moves through the system?
|
|
16
|
+
|
|
17
|
+
### Technology Decisions
|
|
18
|
+
- [ ] **All technologies named** - No "TBD" or "to be decided"?
|
|
19
|
+
- [ ] **Versions specified** - Are technology versions included?
|
|
20
|
+
- [ ] **Decision rationale** - Is the "why" documented for key choices?
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 2. Data Schema Quality
|
|
25
|
+
|
|
26
|
+
### Entity Definitions
|
|
27
|
+
- [ ] **All entities defined** - Do entities match the BRIEF's entities section?
|
|
28
|
+
- [ ] **Primary keys** - Does every entity have a unique identifier?
|
|
29
|
+
- [ ] **Required fields** - Are required vs optional fields marked?
|
|
30
|
+
- [ ] **Field types** - Are data types specified (string, number, date, etc.)?
|
|
31
|
+
|
|
32
|
+
### Relationships
|
|
33
|
+
- [ ] **All relationships mapped** - Are relationships between entities defined?
|
|
34
|
+
- [ ] **Cardinality clear** - 1:1, 1:many, many:many specified?
|
|
35
|
+
- [ ] **Foreign keys** - Are relationship fields identified?
|
|
36
|
+
- [ ] **Cascade behavior** - What happens when parent records are deleted?
|
|
37
|
+
|
|
38
|
+
### Data Integrity
|
|
39
|
+
- [ ] **Unique constraints** - What fields must be unique?
|
|
40
|
+
- [ ] **Validation rules** - Are data validation rules specified?
|
|
41
|
+
- [ ] **Default values** - Are sensible defaults defined?
|
|
42
|
+
- [ ] **Soft delete** - Is deletion strategy defined?
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 3. API Design Quality
|
|
47
|
+
|
|
48
|
+
### Endpoint Coverage
|
|
49
|
+
- [ ] **All features covered** - Is there an API endpoint for each P0 requirement?
|
|
50
|
+
- [ ] **CRUD operations** - Can users create, read, update, delete core entities?
|
|
51
|
+
- [ ] **RESTful design** - Do endpoints follow REST conventions?
|
|
52
|
+
- [ ] **Consistent naming** - Are endpoints named consistently?
|
|
53
|
+
|
|
54
|
+
### Request/Response
|
|
55
|
+
- [ ] **Request schemas** - Are request body formats defined?
|
|
56
|
+
- [ ] **Response schemas** - Are response formats defined?
|
|
57
|
+
- [ ] **Error responses** - Are error formats standardized?
|
|
58
|
+
- [ ] **Status codes** - Are appropriate HTTP status codes used?
|
|
59
|
+
|
|
60
|
+
### Security
|
|
61
|
+
- [ ] **Authentication** - Which endpoints require authentication?
|
|
62
|
+
- [ ] **Authorization** - Which endpoints require specific permissions?
|
|
63
|
+
- [ ] **Rate limiting** - Are rate limits defined for sensitive endpoints?
|
|
64
|
+
- [ ] **Input validation** - Is validation specified for inputs?
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 4. Tech Stack Appropriateness
|
|
69
|
+
|
|
70
|
+
### Frontend
|
|
71
|
+
- [ ] **Framework choice justified** - Does the framework match requirements?
|
|
72
|
+
- [ ] **State management** - Is state management approach defined?
|
|
73
|
+
- [ ] **Styling approach** - Is CSS/styling strategy clear?
|
|
74
|
+
- [ ] **Build tooling** - Is the build process defined?
|
|
75
|
+
|
|
76
|
+
### Backend
|
|
77
|
+
- [ ] **Framework choice justified** - Does it match team skills/requirements?
|
|
78
|
+
- [ ] **Database choice justified** - SQL vs NoSQL decision explained?
|
|
79
|
+
- [ ] **ORM/query approach** - How will data access work?
|
|
80
|
+
- [ ] **Background jobs** - If needed, how will async work be handled?
|
|
81
|
+
|
|
82
|
+
### Infrastructure
|
|
83
|
+
- [ ] **Hosting defined** - Where will this be deployed?
|
|
84
|
+
- [ ] **Environment strategy** - Dev/staging/production plan?
|
|
85
|
+
- [ ] **CI/CD approach** - How will deployments work?
|
|
86
|
+
- [ ] **Monitoring/logging** - How will you know when things break?
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## 5. Security Review
|
|
91
|
+
|
|
92
|
+
### Authentication
|
|
93
|
+
- [ ] **Auth method defined** - Email/password, OAuth, SSO?
|
|
94
|
+
- [ ] **Session management** - How are sessions handled?
|
|
95
|
+
- [ ] **Password requirements** - Are password policies defined?
|
|
96
|
+
- [ ] **Account recovery** - How do users reset passwords?
|
|
97
|
+
|
|
98
|
+
### Authorization
|
|
99
|
+
- [ ] **Permission model** - RBAC, ABAC, or custom?
|
|
100
|
+
- [ ] **Role definitions** - What can each role do?
|
|
101
|
+
- [ ] **Resource ownership** - Can users only access their own data?
|
|
102
|
+
- [ ] **Admin capabilities** - What can admins override?
|
|
103
|
+
|
|
104
|
+
### Data Protection
|
|
105
|
+
- [ ] **Sensitive data identified** - What data needs extra protection?
|
|
106
|
+
- [ ] **Encryption at rest** - Is database encryption planned?
|
|
107
|
+
- [ ] **Encryption in transit** - HTTPS everywhere?
|
|
108
|
+
- [ ] **PII handling** - How is personal data managed?
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## 6. Scalability Considerations
|
|
113
|
+
|
|
114
|
+
### Performance
|
|
115
|
+
- [ ] **Expected load** - What's the expected user count?
|
|
116
|
+
- [ ] **Bottlenecks identified** - What might become slow?
|
|
117
|
+
- [ ] **Caching strategy** - Where will caching help?
|
|
118
|
+
- [ ] **Database indexing** - Are indexes planned for common queries?
|
|
119
|
+
|
|
120
|
+
### Growth Path
|
|
121
|
+
- [ ] **Horizontal scaling** - Can more instances be added?
|
|
122
|
+
- [ ] **Database scaling** - Read replicas? Sharding?
|
|
123
|
+
- [ ] **CDN usage** - For static assets?
|
|
124
|
+
- [ ] **Cost projections** - Any cost estimates at scale?
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## Overall Assessment
|
|
129
|
+
|
|
130
|
+
### Completeness Score
|
|
131
|
+
Count the checked items above: ____ / 55
|
|
132
|
+
|
|
133
|
+
### Scoring Guide
|
|
134
|
+
- **48-55**: Excellent - Ready for `/code-docs`
|
|
135
|
+
- **40-47**: Good - Minor gaps, can proceed with notes
|
|
136
|
+
- **30-39**: Fair - Should address gaps before proceeding
|
|
137
|
+
- **Below 30**: Incomplete - Significant rework needed
|
|
138
|
+
|
|
139
|
+
### Security Concerns
|
|
140
|
+
List any security issues that must be addressed:
|
|
141
|
+
1.
|
|
142
|
+
2.
|
|
143
|
+
3.
|
|
144
|
+
|
|
145
|
+
### Scalability Concerns
|
|
146
|
+
List any scalability issues to monitor:
|
|
147
|
+
1.
|
|
148
|
+
2.
|
|
149
|
+
3.
|
|
150
|
+
|
|
151
|
+
### Technical Debt Risks
|
|
152
|
+
List areas that may accumulate tech debt:
|
|
153
|
+
1.
|
|
154
|
+
2.
|
|
155
|
+
3.
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## Verdict
|
|
160
|
+
|
|
161
|
+
**Ready to proceed to `/code-docs`?**
|
|
162
|
+
|
|
163
|
+
- [ ] **YES** - Architecture is solid and complete
|
|
164
|
+
- [ ] **YES, WITH NOTES** - Minor gaps documented, can proceed
|
|
165
|
+
- [ ] **NO** - Critical gaps must be addressed first
|
|
166
|
+
|
|
167
|
+
**Reviewer notes:**
|
|
168
|
+
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# BRIEF Quality Checklist
|
|
2
|
+
|
|
3
|
+
**Purpose:** Validate that the BRIEF is complete and ready for technical architecture.
|
|
4
|
+
|
|
5
|
+
**When to run:** After completing all 5 BRIEF sections, before running `/code-outline`.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Brainstorm Completeness
|
|
10
|
+
|
|
11
|
+
### Core Idea
|
|
12
|
+
- [ ] **One-sentence description** - Is there a clear, concise one-sentence description of the product?
|
|
13
|
+
- [ ] **Problem statement** - Is the problem being solved clearly articulated?
|
|
14
|
+
- [ ] **Target audience** - Are the target users identified and described?
|
|
15
|
+
- [ ] **Vision for success** - Is there a clear picture of what success looks like?
|
|
16
|
+
- [ ] **Unique value proposition** - What makes this different from alternatives?
|
|
17
|
+
|
|
18
|
+
### Depth Check
|
|
19
|
+
- [ ] Is the problem significant enough to warrant building a solution?
|
|
20
|
+
- [ ] Is the target audience specific (not "everyone")?
|
|
21
|
+
- [ ] Would the success vision be measurable?
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 2. Requirements Completeness
|
|
26
|
+
|
|
27
|
+
### Priority Levels
|
|
28
|
+
- [ ] **P0 (Must Have)** - Are essential features clearly identified?
|
|
29
|
+
- [ ] **P1 (Should Have)** - Are important but non-critical features listed?
|
|
30
|
+
- [ ] **P2 (Could Have)** - Are nice-to-have features separated?
|
|
31
|
+
- [ ] **Constraints** - Are technical/business constraints documented?
|
|
32
|
+
- [ ] **Success metrics** - Are measurable goals defined?
|
|
33
|
+
|
|
34
|
+
### Quality Checks
|
|
35
|
+
- [ ] Are P0 requirements truly essential (MVP would fail without them)?
|
|
36
|
+
- [ ] Are requirements specific and testable (not vague)?
|
|
37
|
+
- [ ] Are there too many P0 requirements (scope creep)?
|
|
38
|
+
- [ ] Do constraints include timeline, budget, or regulatory requirements?
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 3. Inspiration Quality
|
|
43
|
+
|
|
44
|
+
### Reference Products
|
|
45
|
+
- [ ] **Products listed** - Are 2-5 reference products/apps identified?
|
|
46
|
+
- [ ] **Specific aspects** - Is it clear WHAT about each product is inspiring?
|
|
47
|
+
- [ ] **Screenshots/links** - Are visual references provided (in moodboard)?
|
|
48
|
+
- [ ] **Anti-patterns** - Are things to AVOID documented?
|
|
49
|
+
|
|
50
|
+
### Depth Check
|
|
51
|
+
- [ ] Are the inspirations relevant to the problem being solved?
|
|
52
|
+
- [ ] Is it clear which UX patterns to borrow?
|
|
53
|
+
- [ ] Are design aesthetic preferences captured?
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## 4. Entities Definition
|
|
58
|
+
|
|
59
|
+
### User Types
|
|
60
|
+
- [ ] **User types defined** - Are all user types/roles identified?
|
|
61
|
+
- [ ] **Permissions mapped** - Is it clear what each user type can do?
|
|
62
|
+
- [ ] **User journeys** - Are key user journeys outlined?
|
|
63
|
+
|
|
64
|
+
### Data Model
|
|
65
|
+
- [ ] **Core entities** - Are main data types identified (User, Project, etc.)?
|
|
66
|
+
- [ ] **Relationships** - Are relationships between entities defined?
|
|
67
|
+
- [ ] **Key attributes** - Are important fields/properties listed?
|
|
68
|
+
- [ ] **Data ownership** - Is it clear who owns/can modify what data?
|
|
69
|
+
|
|
70
|
+
### Quality Checks
|
|
71
|
+
- [ ] Does the data model support all P0 requirements?
|
|
72
|
+
- [ ] Are there any obvious missing entities?
|
|
73
|
+
- [ ] Are user permissions realistic and implementable?
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## 5. Framework Preferences
|
|
78
|
+
|
|
79
|
+
### Platform
|
|
80
|
+
- [ ] **Target platforms** - Web, mobile, desktop, API?
|
|
81
|
+
- [ ] **Browser support** - Any specific requirements?
|
|
82
|
+
- [ ] **Device support** - Mobile-first? Desktop-first?
|
|
83
|
+
|
|
84
|
+
### Technology
|
|
85
|
+
- [ ] **Tech preferences** - Any required or preferred technologies?
|
|
86
|
+
- [ ] **Integration needs** - Third-party services, APIs, or systems?
|
|
87
|
+
- [ ] **Existing systems** - Anything to integrate with?
|
|
88
|
+
|
|
89
|
+
### Non-Functional Requirements
|
|
90
|
+
- [ ] **Performance** - Any speed/load requirements?
|
|
91
|
+
- [ ] **Security** - Authentication needs, data sensitivity?
|
|
92
|
+
- [ ] **Scalability** - Expected user load?
|
|
93
|
+
- [ ] **Accessibility** - WCAG compliance needs?
|
|
94
|
+
- [ ] **Localization** - Multi-language support?
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Overall Assessment
|
|
99
|
+
|
|
100
|
+
### Completeness Score
|
|
101
|
+
Count the checked items above: ____ / 35
|
|
102
|
+
|
|
103
|
+
### Scoring Guide
|
|
104
|
+
- **30-35**: Excellent - Ready for `/code-outline`
|
|
105
|
+
- **25-29**: Good - Minor gaps, can proceed with notes
|
|
106
|
+
- **20-24**: Fair - Should address gaps before proceeding
|
|
107
|
+
- **Below 20**: Incomplete - Need more information
|
|
108
|
+
|
|
109
|
+
### Blockers (Must Fix)
|
|
110
|
+
List any critical gaps that would block architecture work:
|
|
111
|
+
1.
|
|
112
|
+
2.
|
|
113
|
+
3.
|
|
114
|
+
|
|
115
|
+
### Recommendations
|
|
116
|
+
List suggested improvements (not blocking):
|
|
117
|
+
1.
|
|
118
|
+
2.
|
|
119
|
+
3.
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## Verdict
|
|
124
|
+
|
|
125
|
+
**Ready to proceed to `/code-outline`?**
|
|
126
|
+
|
|
127
|
+
- [ ] **YES** - BRIEF is complete and comprehensive
|
|
128
|
+
- [ ] **YES, WITH NOTES** - Minor gaps documented, can proceed
|
|
129
|
+
- [ ] **NO** - Critical gaps must be addressed first
|
|
130
|
+
|
|
131
|
+
**Reviewer notes:**
|
|
132
|
+
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
# Code Review Checklist
|
|
2
|
+
|
|
3
|
+
**Purpose:** Ensure code quality before merging implementation.
|
|
4
|
+
|
|
5
|
+
**When to run:** After completing story implementation, before merging.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Functionality
|
|
10
|
+
|
|
11
|
+
### Acceptance Criteria
|
|
12
|
+
- [ ] **All AC met** - Does the code satisfy every acceptance criterion?
|
|
13
|
+
- [ ] **Happy path works** - Does the main flow work correctly?
|
|
14
|
+
- [ ] **Edge cases handled** - Are boundary conditions handled?
|
|
15
|
+
- [ ] **Error handling** - Are errors caught and handled gracefully?
|
|
16
|
+
|
|
17
|
+
### User Experience
|
|
18
|
+
- [ ] **Loading states** - Are loading indicators shown during async ops?
|
|
19
|
+
- [ ] **Empty states** - Are empty states handled properly?
|
|
20
|
+
- [ ] **Error messages** - Are error messages helpful and user-friendly?
|
|
21
|
+
- [ ] **Success feedback** - Does the user know when actions succeed?
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 2. Code Quality
|
|
26
|
+
|
|
27
|
+
### Readability
|
|
28
|
+
- [ ] **Clear naming** - Are variables, functions, and classes well-named?
|
|
29
|
+
- [ ] **Comments where needed** - Is complex logic explained?
|
|
30
|
+
- [ ] **No commented-out code** - Is dead code removed?
|
|
31
|
+
- [ ] **Consistent formatting** - Does code follow project style guide?
|
|
32
|
+
|
|
33
|
+
### Structure
|
|
34
|
+
- [ ] **Single responsibility** - Do functions/classes do one thing well?
|
|
35
|
+
- [ ] **DRY principle** - Is code duplication minimized?
|
|
36
|
+
- [ ] **Appropriate abstraction** - Is complexity properly encapsulated?
|
|
37
|
+
- [ ] **File organization** - Are files in the right locations?
|
|
38
|
+
|
|
39
|
+
### Best Practices
|
|
40
|
+
- [ ] **No hardcoded values** - Are magic numbers/strings extracted?
|
|
41
|
+
- [ ] **Proper error types** - Are custom errors used appropriately?
|
|
42
|
+
- [ ] **Async handling** - Are promises/async-await used correctly?
|
|
43
|
+
- [ ] **Resource cleanup** - Are resources (connections, subscriptions) cleaned up?
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 3. Security
|
|
48
|
+
|
|
49
|
+
### Input Validation
|
|
50
|
+
- [ ] **User input validated** - Is all user input validated?
|
|
51
|
+
- [ ] **SQL injection prevented** - Are queries parameterized?
|
|
52
|
+
- [ ] **XSS prevented** - Is output properly escaped?
|
|
53
|
+
- [ ] **CSRF protected** - Are forms protected against CSRF?
|
|
54
|
+
|
|
55
|
+
### Authentication & Authorization
|
|
56
|
+
- [ ] **Auth checks present** - Are protected routes/actions secured?
|
|
57
|
+
- [ ] **Permissions verified** - Is authorization checked before actions?
|
|
58
|
+
- [ ] **Sensitive data protected** - Are secrets not exposed in code?
|
|
59
|
+
- [ ] **No credential logging** - Are credentials not logged?
|
|
60
|
+
|
|
61
|
+
### Data Protection
|
|
62
|
+
- [ ] **PII handled properly** - Is personal data protected?
|
|
63
|
+
- [ ] **Secure communication** - Is HTTPS used for external calls?
|
|
64
|
+
- [ ] **Sensitive headers** - Are security headers set properly?
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 4. Performance
|
|
69
|
+
|
|
70
|
+
### Efficiency
|
|
71
|
+
- [ ] **No unnecessary loops** - Are loops efficient?
|
|
72
|
+
- [ ] **Database queries optimized** - Are N+1 queries avoided?
|
|
73
|
+
- [ ] **Pagination used** - Are large lists paginated?
|
|
74
|
+
- [ ] **Caching considered** - Is caching used where beneficial?
|
|
75
|
+
|
|
76
|
+
### Frontend Performance
|
|
77
|
+
- [ ] **No unnecessary re-renders** - Is React rendering optimized?
|
|
78
|
+
- [ ] **Images optimized** - Are images properly sized/compressed?
|
|
79
|
+
- [ ] **Lazy loading** - Are large components/routes lazy loaded?
|
|
80
|
+
- [ ] **Bundle size** - Does the change avoid bloating the bundle?
|
|
81
|
+
|
|
82
|
+
### Resource Management
|
|
83
|
+
- [ ] **Memory leaks** - Are event listeners/subscriptions cleaned up?
|
|
84
|
+
- [ ] **Connection pooling** - Are database connections managed properly?
|
|
85
|
+
- [ ] **Timeout handling** - Do network requests have timeouts?
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 5. Testing
|
|
90
|
+
|
|
91
|
+
### Test Coverage
|
|
92
|
+
- [ ] **Unit tests written** - Are new functions tested?
|
|
93
|
+
- [ ] **Integration tests** - Are component interactions tested?
|
|
94
|
+
- [ ] **Edge cases tested** - Are boundary conditions covered?
|
|
95
|
+
- [ ] **Error cases tested** - Are error scenarios tested?
|
|
96
|
+
|
|
97
|
+
### Test Quality
|
|
98
|
+
- [ ] **Tests are meaningful** - Do tests actually verify behavior?
|
|
99
|
+
- [ ] **Tests are independent** - Can tests run in any order?
|
|
100
|
+
- [ ] **Tests are readable** - Are test names descriptive?
|
|
101
|
+
- [ ] **No flaky tests** - Are tests reliable and repeatable?
|
|
102
|
+
|
|
103
|
+
### Coverage
|
|
104
|
+
- [ ] **Critical paths covered** - Are happy paths tested?
|
|
105
|
+
- [ ] **Error paths covered** - Are error scenarios tested?
|
|
106
|
+
- [ ] **Regression tests** - Are existing tests still passing?
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## 6. Documentation
|
|
111
|
+
|
|
112
|
+
### Code Documentation
|
|
113
|
+
- [ ] **Complex logic documented** - Are tricky parts explained?
|
|
114
|
+
- [ ] **Public APIs documented** - Are exported functions documented?
|
|
115
|
+
- [ ] **Type definitions** - Are types properly defined (if using TS)?
|
|
116
|
+
- [ ] **README updated** - Is project README current?
|
|
117
|
+
|
|
118
|
+
### API Documentation
|
|
119
|
+
- [ ] **Endpoints documented** - Are new endpoints in API docs?
|
|
120
|
+
- [ ] **Request/response examples** - Are examples provided?
|
|
121
|
+
- [ ] **Error codes documented** - Are error responses documented?
|
|
122
|
+
|
|
123
|
+
### Change Documentation
|
|
124
|
+
- [ ] **Commit messages clear** - Are commits well-described?
|
|
125
|
+
- [ ] **PR description complete** - Does PR explain the change?
|
|
126
|
+
- [ ] **Changelog updated** - Is the change logged?
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## 7. Architecture Compliance
|
|
131
|
+
|
|
132
|
+
### Design Patterns
|
|
133
|
+
- [ ] **Follows architecture** - Does code align with technical outline?
|
|
134
|
+
- [ ] **Consistent patterns** - Are established patterns followed?
|
|
135
|
+
- [ ] **No anti-patterns** - Are known anti-patterns avoided?
|
|
136
|
+
- [ ] **Proper separation** - Are concerns properly separated?
|
|
137
|
+
|
|
138
|
+
### Dependencies
|
|
139
|
+
- [ ] **Minimal new deps** - Are new dependencies justified?
|
|
140
|
+
- [ ] **Deps up to date** - Are dependencies recent and maintained?
|
|
141
|
+
- [ ] **No security vulnerabilities** - Do deps pass security audit?
|
|
142
|
+
- [ ] **License compatible** - Are dependency licenses compatible?
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## 8. Deployment Readiness
|
|
147
|
+
|
|
148
|
+
### Configuration
|
|
149
|
+
- [ ] **Environment variables** - Are new env vars documented?
|
|
150
|
+
- [ ] **Feature flags** - Are feature flags used appropriately?
|
|
151
|
+
- [ ] **Database migrations** - Are migrations reversible?
|
|
152
|
+
- [ ] **Backward compatible** - Is the change backward compatible?
|
|
153
|
+
|
|
154
|
+
### Monitoring
|
|
155
|
+
- [ ] **Logging added** - Are important events logged?
|
|
156
|
+
- [ ] **Metrics tracked** - Are key metrics measured?
|
|
157
|
+
- [ ] **Alerts configured** - Are alerts set for failures?
|
|
158
|
+
- [ ] **Error tracking** - Are errors captured in monitoring?
|
|
159
|
+
|
|
160
|
+
### Rollback
|
|
161
|
+
- [ ] **Rollback plan** - Can this change be reverted?
|
|
162
|
+
- [ ] **Data migrations reversible** - Can data changes be undone?
|
|
163
|
+
- [ ] **Feature flag kill switch** - Can the feature be disabled?
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
## Overall Assessment
|
|
168
|
+
|
|
169
|
+
### Completeness Score
|
|
170
|
+
Count the checked items above: ____ / 70
|
|
171
|
+
|
|
172
|
+
### Scoring Guide
|
|
173
|
+
- **63-70**: Excellent - Ready to merge
|
|
174
|
+
- **55-62**: Good - Minor issues, can merge with notes
|
|
175
|
+
- **45-54**: Fair - Should address issues before merging
|
|
176
|
+
- **Below 45**: Needs Work - Significant issues to resolve
|
|
177
|
+
|
|
178
|
+
### Blockers (Must Fix)
|
|
179
|
+
Issues that must be resolved before merging:
|
|
180
|
+
1.
|
|
181
|
+
2.
|
|
182
|
+
3.
|
|
183
|
+
|
|
184
|
+
### Warnings (Should Fix)
|
|
185
|
+
Issues that should be addressed but aren't blocking:
|
|
186
|
+
1.
|
|
187
|
+
2.
|
|
188
|
+
3.
|
|
189
|
+
|
|
190
|
+
### Suggestions (Nice to Have)
|
|
191
|
+
Improvements for future consideration:
|
|
192
|
+
1.
|
|
193
|
+
2.
|
|
194
|
+
3.
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
## Verdict
|
|
199
|
+
|
|
200
|
+
**Ready to merge?**
|
|
201
|
+
|
|
202
|
+
- [ ] **APPROVE** - Code is ready to merge
|
|
203
|
+
- [ ] **APPROVE WITH COMMENTS** - Minor issues noted, can merge
|
|
204
|
+
- [ ] **REQUEST CHANGES** - Issues must be addressed first
|
|
205
|
+
|
|
206
|
+
**Reviewer:**
|
|
207
|
+
|
|
208
|
+
**Date:**
|
|
209
|
+
|
|
210
|
+
**Notes:**
|
|
211
|
+
|