@arvorco/relentless 0.1.0 → 0.1.6
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 +30 -13
- package/bin/relentless.ts +1 -1
- package/package.json +3 -2
- package/.claude/commands/relentless.plan.old.md +0 -89
- package/.claude/settings.local.json +0 -23
- package/.claude/skills/analyze/SKILL.md +0 -149
- package/.claude/skills/checklist/SKILL.md +0 -173
- package/.claude/skills/checklist/templates/checklist-template.md +0 -40
- package/.claude/skills/clarify/SKILL.md +0 -174
- package/.claude/skills/constitution/SKILL.md +0 -150
- package/.claude/skills/constitution/templates/constitution-template.md +0 -228
- package/.claude/skills/implement/SKILL.md +0 -141
- package/.claude/skills/plan/SKILL.md +0 -179
- package/.claude/skills/plan/templates/plan-template.md +0 -104
- package/.claude/skills/prd/SKILL.md +0 -242
- package/.claude/skills/relentless/SKILL.md +0 -265
- package/.claude/skills/specify/SKILL.md +0 -220
- package/.claude/skills/specify/scripts/bash/check-prerequisites.sh +0 -166
- package/.claude/skills/specify/scripts/bash/common.sh +0 -156
- package/.claude/skills/specify/scripts/bash/create-new-feature.sh +0 -305
- package/.claude/skills/specify/scripts/bash/setup-plan.sh +0 -61
- package/.claude/skills/specify/scripts/bash/update-agent-context.sh +0 -799
- package/.claude/skills/specify/templates/spec-template.md +0 -115
- package/.claude/skills/tasks/SKILL.md +0 -202
- package/.claude/skills/tasks/templates/tasks-template.md +0 -251
- package/.claude/skills/taskstoissues/SKILL.md +0 -97
- package/.specify/memory/constitution.md +0 -50
- package/.specify/scripts/bash/check-prerequisites.sh +0 -166
- package/.specify/scripts/bash/common.sh +0 -156
- package/.specify/scripts/bash/create-new-feature.sh +0 -297
- package/.specify/scripts/bash/setup-plan.sh +0 -61
- package/.specify/scripts/bash/update-agent-context.sh +0 -799
- package/.specify/templates/agent-file-template.md +0 -28
- package/.specify/templates/checklist-template.md +0 -40
- package/.specify/templates/plan-template.md +0 -104
- package/.specify/templates/spec-template.md +0 -115
- package/.specify/templates/tasks-template.md +0 -251
- package/CHANGES_SUMMARY.md +0 -255
- package/CLAUDE.md +0 -92
- package/GEMINI_SETUP.md +0 -256
- package/REFACTOR_SUMMARY.md +0 -267
- package/bun.lock +0 -352
- package/prompt.md +0 -108
- package/ralph.sh +0 -80
- package/relentless/features/ghsk-ideas/prd.json +0 -229
- package/relentless/features/ghsk-ideas/prd.md +0 -191
- package/relentless/features/ghsk-ideas/progress.txt +0 -408
- package/relentless/prompt.md +0 -79
- package/skills/checklist/SKILL.md +0 -349
- package/skills/clarify/SKILL.md +0 -476
- package/skills/prd/SKILL.md +0 -242
- package/skills/relentless/SKILL.md +0 -268
- package/skills/tasks/SKILL.md +0 -577
package/README.md
CHANGED
|
@@ -20,6 +20,10 @@
|
|
|
20
20
|
**For Claude Code, Amp, or OpenCode users** (Recommended - Full Skills Support):
|
|
21
21
|
```bash
|
|
22
22
|
# 1. Install Relentless globally
|
|
23
|
+
npm install -g @arvorco/relentless
|
|
24
|
+
# or with bun
|
|
25
|
+
bun install -g @arvorco/relentless
|
|
26
|
+
# or directly from GitHub
|
|
23
27
|
bun install -g github:ArvorCo/Relentless
|
|
24
28
|
|
|
25
29
|
# 2. Initialize in your project
|
|
@@ -45,7 +49,9 @@ relentless run --feature 003-user-auth --tui
|
|
|
45
49
|
**For Droid, Codex, or other agents** (Manual Workflow):
|
|
46
50
|
```bash
|
|
47
51
|
# 1. Install and initialize
|
|
48
|
-
|
|
52
|
+
npm install -g @arvorco/relentless
|
|
53
|
+
# or
|
|
54
|
+
bun install -g @arvorco/relentless
|
|
49
55
|
cd your-project
|
|
50
56
|
relentless init
|
|
51
57
|
|
|
@@ -158,35 +164,46 @@ Five specialized skills for Claude Code, Amp, and other AI agents:
|
|
|
158
164
|
|
|
159
165
|
### Prerequisites
|
|
160
166
|
|
|
161
|
-
- [Bun](https://bun.sh) runtime
|
|
167
|
+
- [Bun](https://bun.sh) runtime (recommended) or Node.js 20+
|
|
162
168
|
- At least one AI coding agent installed (Claude Code, Amp, etc.)
|
|
163
169
|
|
|
164
170
|
```bash
|
|
165
|
-
# Install Bun (
|
|
171
|
+
# Install Bun (recommended)
|
|
166
172
|
curl -fsSL https://bun.sh/install | bash
|
|
167
173
|
```
|
|
168
174
|
|
|
169
|
-
### Option 1:
|
|
175
|
+
### Option 1: Install from npm (Recommended)
|
|
170
176
|
|
|
171
177
|
```bash
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
178
|
+
# Using npm
|
|
179
|
+
npm install -g @arvorco/relentless
|
|
180
|
+
|
|
181
|
+
# Using bun (faster)
|
|
182
|
+
bun install -g @arvorco/relentless
|
|
183
|
+
|
|
184
|
+
# Using bunx (no installation)
|
|
185
|
+
bunx @arvorco/relentless init
|
|
175
186
|
```
|
|
176
187
|
|
|
177
|
-
### Option 2: Install
|
|
188
|
+
### Option 2: Install from GitHub
|
|
178
189
|
|
|
179
190
|
```bash
|
|
191
|
+
# Latest stable release
|
|
180
192
|
bun install -g github:ArvorCo/Relentless
|
|
181
193
|
|
|
182
|
-
# Or
|
|
183
|
-
|
|
194
|
+
# Or run directly
|
|
195
|
+
bunx github:ArvorCo/Relentless init
|
|
184
196
|
```
|
|
185
197
|
|
|
186
|
-
### Option 3:
|
|
198
|
+
### Option 3: Clone for Development
|
|
187
199
|
|
|
188
200
|
```bash
|
|
189
|
-
|
|
201
|
+
git clone https://github.com/ArvorCo/Relentless.git
|
|
202
|
+
cd Relentless
|
|
203
|
+
bun install
|
|
204
|
+
|
|
205
|
+
# Run locally
|
|
206
|
+
bun run bin/relentless.ts --help
|
|
190
207
|
```
|
|
191
208
|
|
|
192
209
|
---
|
|
@@ -398,7 +415,7 @@ Support through extensions or alternative mechanisms:
|
|
|
398
415
|
|-------|---------|--------|
|
|
399
416
|
| **Gemini** | `gemini` | 🔄 Extensions (see below) |
|
|
400
417
|
|
|
401
|
-
**Gemini Setup:** See [GEMINI_SETUP.md](./GEMINI_SETUP.md) for extensions integration guide.
|
|
418
|
+
**Gemini Setup:** See [docs/GEMINI_SETUP.md](./docs/GEMINI_SETUP.md) for extensions integration guide.
|
|
402
419
|
|
|
403
420
|
### Tier 3: Manual/CLI Workflow
|
|
404
421
|
|
package/bin/relentless.ts
CHANGED
|
@@ -179,9 +179,9 @@ program
|
|
|
179
179
|
const checklistPath = join(featureDir, "checklist.md");
|
|
180
180
|
if (existsSync(checklistPath)) {
|
|
181
181
|
console.log(chalk.dim(" Merging checklist.md criteria..."));
|
|
182
|
-
const checklistContent = await Bun.file(checklistPath).text();
|
|
183
182
|
// TODO: Parse checklist and merge into acceptance criteria
|
|
184
183
|
// For now, just note that it exists
|
|
184
|
+
// const checklistContent = await Bun.file(checklistPath).text();
|
|
185
185
|
}
|
|
186
186
|
}
|
|
187
187
|
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arvorco/relentless",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.6",
|
|
4
4
|
"description": "Universal AI agent orchestrator - works with Claude Code, Amp, OpenCode, Codex, Droid, and Gemini",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"publishConfig": {
|
|
7
7
|
"access": "public"
|
|
8
8
|
},
|
|
9
9
|
"bin": {
|
|
10
|
-
"relentless": "
|
|
10
|
+
"relentless": "bin/relentless.ts"
|
|
11
11
|
},
|
|
12
12
|
"scripts": {
|
|
13
13
|
"start": "bun run bin/relentless.ts",
|
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
"test": "bun test"
|
|
18
18
|
},
|
|
19
19
|
"dependencies": {
|
|
20
|
+
"@arvorco/relentless": "^0.1.0",
|
|
20
21
|
"chalk": "^5.3.0",
|
|
21
22
|
"commander": "^12.1.0",
|
|
22
23
|
"figures": "^6.0.0",
|
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Execute the implementation planning workflow using the plan template to generate design artifacts.
|
|
3
|
-
handoffs:
|
|
4
|
-
- label: Create Tasks
|
|
5
|
-
agent: relentless.tasks
|
|
6
|
-
prompt: Break the plan into tasks
|
|
7
|
-
send: true
|
|
8
|
-
- label: Create Checklist
|
|
9
|
-
agent: relentless.checklist
|
|
10
|
-
prompt: Create a checklist for the following domain...
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## User Input
|
|
14
|
-
|
|
15
|
-
```text
|
|
16
|
-
$ARGUMENTS
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
You **MUST** consider the user input before proceeding (if not empty).
|
|
20
|
-
|
|
21
|
-
## Outline
|
|
22
|
-
|
|
23
|
-
1. **Setup**: Run `.specify/scripts/bash/setup-plan.sh --json` from repo root and parse JSON for FEATURE_SPEC, IMPL_PLAN, SPECS_DIR, BRANCH. For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
|
24
|
-
|
|
25
|
-
2. **Load context**: Read FEATURE_SPEC and `.specify/memory/constitution.md`. Load IMPL_PLAN template (already copied).
|
|
26
|
-
|
|
27
|
-
3. **Execute plan workflow**: Follow the structure in IMPL_PLAN template to:
|
|
28
|
-
- Fill Technical Context (mark unknowns as "NEEDS CLARIFICATION")
|
|
29
|
-
- Fill Constitution Check section from constitution
|
|
30
|
-
- Evaluate gates (ERROR if violations unjustified)
|
|
31
|
-
- Phase 0: Generate research.md (resolve all NEEDS CLARIFICATION)
|
|
32
|
-
- Phase 1: Generate data-model.md, contracts/, quickstart.md
|
|
33
|
-
- Phase 1: Update agent context by running the agent script
|
|
34
|
-
- Re-evaluate Constitution Check post-design
|
|
35
|
-
|
|
36
|
-
4. **Stop and report**: Command ends after Phase 2 planning. Report branch, IMPL_PLAN path, and generated artifacts.
|
|
37
|
-
|
|
38
|
-
## Phases
|
|
39
|
-
|
|
40
|
-
### Phase 0: Outline & Research
|
|
41
|
-
|
|
42
|
-
1. **Extract unknowns from Technical Context** above:
|
|
43
|
-
- For each NEEDS CLARIFICATION → research task
|
|
44
|
-
- For each dependency → best practices task
|
|
45
|
-
- For each integration → patterns task
|
|
46
|
-
|
|
47
|
-
2. **Generate and dispatch research agents**:
|
|
48
|
-
|
|
49
|
-
```text
|
|
50
|
-
For each unknown in Technical Context:
|
|
51
|
-
Task: "Research {unknown} for {feature context}"
|
|
52
|
-
For each technology choice:
|
|
53
|
-
Task: "Find best practices for {tech} in {domain}"
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
3. **Consolidate findings** in `research.md` using format:
|
|
57
|
-
- Decision: [what was chosen]
|
|
58
|
-
- Rationale: [why chosen]
|
|
59
|
-
- Alternatives considered: [what else evaluated]
|
|
60
|
-
|
|
61
|
-
**Output**: research.md with all NEEDS CLARIFICATION resolved
|
|
62
|
-
|
|
63
|
-
### Phase 1: Design & Contracts
|
|
64
|
-
|
|
65
|
-
**Prerequisites:** `research.md` complete
|
|
66
|
-
|
|
67
|
-
1. **Extract entities from feature spec** → `data-model.md`:
|
|
68
|
-
- Entity name, fields, relationships
|
|
69
|
-
- Validation rules from requirements
|
|
70
|
-
- State transitions if applicable
|
|
71
|
-
|
|
72
|
-
2. **Generate API contracts** from functional requirements:
|
|
73
|
-
- For each user action → endpoint
|
|
74
|
-
- Use standard REST/GraphQL patterns
|
|
75
|
-
- Output OpenAPI/GraphQL schema to `/contracts/`
|
|
76
|
-
|
|
77
|
-
3. **Agent context update**:
|
|
78
|
-
- Run `.specify/scripts/bash/update-agent-context.sh claude`
|
|
79
|
-
- These scripts detect which AI agent is in use
|
|
80
|
-
- Update the appropriate agent-specific context file
|
|
81
|
-
- Add only new technology from current plan
|
|
82
|
-
- Preserve manual additions between markers
|
|
83
|
-
|
|
84
|
-
**Output**: data-model.md, /contracts/*, quickstart.md, agent-specific file
|
|
85
|
-
|
|
86
|
-
## Key rules
|
|
87
|
-
|
|
88
|
-
- Use absolute paths
|
|
89
|
-
- ERROR on gate failures or unresolved clarifications
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"permissions": {
|
|
3
|
-
"allow": [
|
|
4
|
-
"WebSearch",
|
|
5
|
-
"Bash(amp --help:*)",
|
|
6
|
-
"Bash(opencode --help:*)",
|
|
7
|
-
"Bash(codex:*)",
|
|
8
|
-
"Bash(droid:*)",
|
|
9
|
-
"Bash(gemini:*)",
|
|
10
|
-
"Bash(node --version:*)",
|
|
11
|
-
"Bash(bun --version)",
|
|
12
|
-
"Bash(opencode agent:*)",
|
|
13
|
-
"Bash(tree:*)",
|
|
14
|
-
"Bash(jq:*)",
|
|
15
|
-
"Bash(bun run lint:*)",
|
|
16
|
-
"Bash(bun run typecheck:*)",
|
|
17
|
-
"Bash(bun build:*)",
|
|
18
|
-
"Bash(bun run:*)",
|
|
19
|
-
"Bash(git diff:*)",
|
|
20
|
-
"Bash(git add:*)"
|
|
21
|
-
]
|
|
22
|
-
}
|
|
23
|
-
}
|
|
@@ -1,149 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: analyze
|
|
3
|
-
description: "Analyze consistency across spec, plan, tasks, and checklist. Use before implementation. Triggers on: analyze consistency, check artifacts, validate feature."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Cross-Artifact Consistency Analyzer
|
|
7
|
-
|
|
8
|
-
Validate consistency across feature artifacts before implementation.
|
|
9
|
-
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
## The Job
|
|
13
|
-
|
|
14
|
-
1. Read all feature artifacts
|
|
15
|
-
2. Check for consistency issues
|
|
16
|
-
3. Validate against constitution
|
|
17
|
-
4. Report findings
|
|
18
|
-
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
## Files to Analyze
|
|
22
|
-
|
|
23
|
-
Required:
|
|
24
|
-
- `relentless/constitution.md`
|
|
25
|
-
- `relentless/features/NNN-feature/spec.md`
|
|
26
|
-
- `relentless/features/NNN-feature/plan.md`
|
|
27
|
-
- `relentless/features/NNN-feature/tasks.md`
|
|
28
|
-
- `relentless/features/NNN-feature/checklist.md`
|
|
29
|
-
|
|
30
|
-
Optional:
|
|
31
|
-
- `relentless/features/NNN-feature/prd.json`
|
|
32
|
-
- `relentless/features/NNN-feature/progress.txt`
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
## Validation Checks
|
|
37
|
-
|
|
38
|
-
### 1. Completeness
|
|
39
|
-
- [ ] All functional requirements from spec have tasks
|
|
40
|
-
- [ ] All tasks reference spec requirements
|
|
41
|
-
- [ ] Plan addresses all spec requirements
|
|
42
|
-
- [ ] Checklist covers all tasks
|
|
43
|
-
|
|
44
|
-
### 2. Constitution Compliance
|
|
45
|
-
- [ ] Plan follows MUST rules
|
|
46
|
-
- [ ] Tasks include required quality checks
|
|
47
|
-
- [ ] Testing requirements met
|
|
48
|
-
- [ ] Security requirements addressed
|
|
49
|
-
|
|
50
|
-
### 3. Dependency Consistency
|
|
51
|
-
- [ ] Task dependencies are valid (no circular refs)
|
|
52
|
-
- [ ] Referenced dependencies exist
|
|
53
|
-
- [ ] Dependency order makes sense
|
|
54
|
-
|
|
55
|
-
### 4. Scope Consistency
|
|
56
|
-
- [ ] Plan doesn't include out-of-scope items
|
|
57
|
-
- [ ] Tasks match plan scope
|
|
58
|
-
- [ ] No scope creep in checklist
|
|
59
|
-
|
|
60
|
-
### 5. Data Model Consistency
|
|
61
|
-
- [ ] Entities mentioned in spec are in plan
|
|
62
|
-
- [ ] Plan data models match spec requirements
|
|
63
|
-
- [ ] Tasks create required entities
|
|
64
|
-
|
|
65
|
-
### 6. API Consistency
|
|
66
|
-
- [ ] Endpoints in plan match spec scenarios
|
|
67
|
-
- [ ] Tasks implement all planned endpoints
|
|
68
|
-
- [ ] Checklist validates all endpoints
|
|
69
|
-
|
|
70
|
-
### 7. Testing Coverage
|
|
71
|
-
- [ ] Each task has test acceptance criteria
|
|
72
|
-
- [ ] Checklist includes test validation
|
|
73
|
-
- [ ] Test types match constitution requirements
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
## Issue Severity
|
|
78
|
-
|
|
79
|
-
**CRITICAL:** Blocks implementation
|
|
80
|
-
- Constitution MUST rule violations
|
|
81
|
-
- Circular dependencies
|
|
82
|
-
- Missing required artifacts
|
|
83
|
-
|
|
84
|
-
**WARNING:** Should fix before implementation
|
|
85
|
-
- Incomplete coverage of requirements
|
|
86
|
-
- Ambiguous acceptance criteria
|
|
87
|
-
- Missing test criteria
|
|
88
|
-
|
|
89
|
-
**INFO:** Nice to have
|
|
90
|
-
- Style inconsistencies
|
|
91
|
-
- Minor gaps in checklist
|
|
92
|
-
- Optimization opportunities
|
|
93
|
-
|
|
94
|
-
---
|
|
95
|
-
|
|
96
|
-
## Report Format
|
|
97
|
-
|
|
98
|
-
```markdown
|
|
99
|
-
# Consistency Analysis: Feature Name
|
|
100
|
-
|
|
101
|
-
**Date:** 2026-01-11
|
|
102
|
-
**Status:** PASS / ISSUES FOUND
|
|
103
|
-
|
|
104
|
-
## Summary
|
|
105
|
-
- Stories: N/M completed
|
|
106
|
-
- Issues: X total (Y critical, Z warnings, W info)
|
|
107
|
-
|
|
108
|
-
## Critical Issues
|
|
109
|
-
|
|
110
|
-
### CRIT-001: Circular Dependency
|
|
111
|
-
**Location:** tasks.md
|
|
112
|
-
**Details:** US-002 depends on US-003, US-003 depends on US-002
|
|
113
|
-
**Fix:** Remove circular dependency, reorder tasks
|
|
114
|
-
|
|
115
|
-
## Warnings
|
|
116
|
-
|
|
117
|
-
### WARN-001: Missing Test Coverage
|
|
118
|
-
**Location:** tasks.md, US-004
|
|
119
|
-
**Details:** No integration test in acceptance criteria
|
|
120
|
-
**Fix:** Add integration test requirement
|
|
121
|
-
|
|
122
|
-
## Info
|
|
123
|
-
|
|
124
|
-
### INFO-001: Checklist Gap
|
|
125
|
-
**Location:** checklist.md
|
|
126
|
-
**Details:** No performance validation for US-005
|
|
127
|
-
**Suggestion:** Add performance checklist item
|
|
128
|
-
|
|
129
|
-
## Recommendations
|
|
130
|
-
|
|
131
|
-
1. Fix all CRITICAL issues before proceeding
|
|
132
|
-
2. Address WARNINGS for better quality
|
|
133
|
-
3. Consider INFO items for completeness
|
|
134
|
-
|
|
135
|
-
**Next Steps:**
|
|
136
|
-
- If CRITICAL issues: Fix and re-run analysis
|
|
137
|
-
- If only WARNINGS: Proceed with caution
|
|
138
|
-
- If PASS: Ready for `/relentless.implement`
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
---
|
|
142
|
-
|
|
143
|
-
## Notes
|
|
144
|
-
|
|
145
|
-
- Run before starting implementation
|
|
146
|
-
- Constitution compliance is non-negotiable
|
|
147
|
-
- Fix critical issues immediately
|
|
148
|
-
- Warnings can sometimes be deferred
|
|
149
|
-
- Re-run after making fixes
|
|
@@ -1,173 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: checklist
|
|
3
|
-
description: "Generate quality validation checklist from spec, plan, and tasks. Use after creating tasks. Triggers on: create checklist, quality checklist, validation checklist."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Quality Validation Checklist Generator
|
|
7
|
-
|
|
8
|
-
Generate domain-specific quality checklists to validate implementation completeness.
|
|
9
|
-
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
## The Job
|
|
13
|
-
|
|
14
|
-
1. Read spec.md, plan.md, and tasks.md
|
|
15
|
-
2. Extract quality requirements from constitution
|
|
16
|
-
3. Generate comprehensive checklist
|
|
17
|
-
4. Save to `checklist.md`
|
|
18
|
-
|
|
19
|
-
**Important:** Checklist items get merged into prd.json acceptance criteria!
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## Step 1: Locate Feature Files
|
|
24
|
-
|
|
25
|
-
Verify these files exist:
|
|
26
|
-
- `relentless/features/NNN-feature/spec.md`
|
|
27
|
-
- `relentless/features/NNN-feature/plan.md`
|
|
28
|
-
- `relentless/features/NNN-feature/tasks.md`
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
## Step 2: Load Context
|
|
33
|
-
|
|
34
|
-
Read:
|
|
35
|
-
1. `relentless/constitution.md` - Quality standards and requirements
|
|
36
|
-
2. Feature files (spec, plan, tasks)
|
|
37
|
-
3. Identify the feature domain (auth, payments, dashboard, etc.)
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## Step 3: Generate Checklist Categories
|
|
42
|
-
|
|
43
|
-
Create 5-7 categories based on feature domain:
|
|
44
|
-
|
|
45
|
-
**Common Categories:**
|
|
46
|
-
- Schema & Database
|
|
47
|
-
- Backend Logic
|
|
48
|
-
- Frontend Components (if applicable)
|
|
49
|
-
- API Integration
|
|
50
|
-
- Testing & Validation
|
|
51
|
-
- Security & Permissions
|
|
52
|
-
- Performance & UX
|
|
53
|
-
- Documentation
|
|
54
|
-
|
|
55
|
-
---
|
|
56
|
-
|
|
57
|
-
## Step 4: Generate Checklist Items
|
|
58
|
-
|
|
59
|
-
For each category, create 5-10 specific validation items:
|
|
60
|
-
|
|
61
|
-
**Format:**
|
|
62
|
-
```markdown
|
|
63
|
-
- [ ] CHK-001 [US-001] Specific, testable requirement
|
|
64
|
-
- [ ] CHK-002 [Gap] Missing specification identified
|
|
65
|
-
- [ ] CHK-003 [Ambiguity] Unclear requirement needs clarification
|
|
66
|
-
- [ ] CHK-004 [Edge Case] Potential edge case to handle
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
**Guidelines:**
|
|
70
|
-
- 80% of items should reference specific user stories `[US-XXX]`
|
|
71
|
-
- 20% should identify gaps, ambiguities, or edge cases
|
|
72
|
-
- Each item must be specific and testable
|
|
73
|
-
- Total: 20-40 items across all categories
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
## Step 5: Reference Constitution
|
|
78
|
-
|
|
79
|
-
Ensure checklist includes items for constitution MUST rules:
|
|
80
|
-
- Type safety requirements
|
|
81
|
-
- Testing coverage
|
|
82
|
-
- Security standards
|
|
83
|
-
- Performance expectations
|
|
84
|
-
- Code quality standards
|
|
85
|
-
|
|
86
|
-
---
|
|
87
|
-
|
|
88
|
-
## Step 6: Save & Report
|
|
89
|
-
|
|
90
|
-
1. Save to `relentless/features/NNN-feature/checklist.md`
|
|
91
|
-
2. Report:
|
|
92
|
-
- Total checklist items: N
|
|
93
|
-
- Items per category
|
|
94
|
-
- Constitution compliance items: N
|
|
95
|
-
- Gaps identified: N
|
|
96
|
-
- Next step: `relentless convert tasks.md`
|
|
97
|
-
|
|
98
|
-
---
|
|
99
|
-
|
|
100
|
-
## Example Checklist
|
|
101
|
-
|
|
102
|
-
```markdown
|
|
103
|
-
# Quality Checklist: User Authentication
|
|
104
|
-
|
|
105
|
-
**Purpose:** Validate completeness of user authentication implementation
|
|
106
|
-
**Created:** 2026-01-11
|
|
107
|
-
**Feature:** [spec.md](./spec.md)
|
|
108
|
-
|
|
109
|
-
## Schema & Database
|
|
110
|
-
|
|
111
|
-
- [ ] CHK-001 [US-001] User table has all required fields (id, email, password_hash, confirmed, timestamps)
|
|
112
|
-
- [ ] CHK-002 [US-001] Email field has UNIQUE constraint
|
|
113
|
-
- [ ] CHK-003 [US-001] Indexes created on frequently queried fields (email)
|
|
114
|
-
- [ ] CHK-004 [Gap] Consider adding last_login_at timestamp for analytics
|
|
115
|
-
- [ ] CHK-005 [US-001] Migration script tested on clean database
|
|
116
|
-
|
|
117
|
-
## Backend Logic
|
|
118
|
-
|
|
119
|
-
- [ ] CHK-006 [US-001] Password hashing uses bcrypt with appropriate cost factor
|
|
120
|
-
- [ ] CHK-007 [US-001] Email validation prevents common typos and invalid formats
|
|
121
|
-
- [ ] CHK-008 [US-002] JWT tokens include user ID and expiration
|
|
122
|
-
- [ ] CHK-009 [US-002] Token verification handles expired tokens gracefully
|
|
123
|
-
- [ ] CHK-010 [Ambiguity] Password reset flow not specified - out of scope?
|
|
124
|
-
|
|
125
|
-
## API Integration
|
|
126
|
-
|
|
127
|
-
- [ ] CHK-011 [US-001] POST /api/auth/register returns 201 on success
|
|
128
|
-
- [ ] CHK-012 [US-001] Register endpoint returns 400 for invalid email
|
|
129
|
-
- [ ] CHK-013 [US-001] Register endpoint returns 409 for duplicate email
|
|
130
|
-
- [ ] CHK-014 [US-002] POST /api/auth/login returns 401 for wrong password
|
|
131
|
-
- [ ] CHK-015 [US-002] Login endpoint returns 403 for unconfirmed account
|
|
132
|
-
- [ ] CHK-016 [Edge Case] Rate limiting on auth endpoints to prevent brute force
|
|
133
|
-
|
|
134
|
-
## Testing & Validation
|
|
135
|
-
|
|
136
|
-
- [ ] CHK-017 [US-001] Unit tests for password hashing utility
|
|
137
|
-
- [ ] CHK-018 [US-001] Unit tests for email validation
|
|
138
|
-
- [ ] CHK-019 [US-002] Integration test for full registration flow
|
|
139
|
-
- [ ] CHK-020 [US-002] Integration test for login flow
|
|
140
|
-
- [ ] CHK-021 [US-003] E2E test for email confirmation
|
|
141
|
-
- [ ] CHK-022 [Constitution] Test coverage meets minimum 80% requirement
|
|
142
|
-
|
|
143
|
-
## Security & Permissions
|
|
144
|
-
|
|
145
|
-
- [ ] CHK-023 [US-001] Passwords never logged or exposed in errors
|
|
146
|
-
- [ ] CHK-024 [US-001] Password requirements enforced (min length, complexity)
|
|
147
|
-
- [ ] CHK-025 [US-002] JWT secret stored in environment variable, not code
|
|
148
|
-
- [ ] CHK-026 [US-002] Token expiration validated on every request
|
|
149
|
-
- [ ] CHK-027 [Gap] Consider adding account lockout after N failed attempts
|
|
150
|
-
|
|
151
|
-
## Performance & UX
|
|
152
|
-
|
|
153
|
-
- [ ] CHK-028 [US-001] Registration completes within 2 seconds
|
|
154
|
-
- [ ] CHK-029 [US-002] Login completes within 1 second
|
|
155
|
-
- [ ] CHK-030 [US-003] Confirmation email sent within 30 seconds
|
|
156
|
-
- [ ] CHK-031 [Edge Case] Graceful handling when email service is down
|
|
157
|
-
|
|
158
|
-
## Documentation
|
|
159
|
-
|
|
160
|
-
- [ ] CHK-032 API endpoints documented with examples
|
|
161
|
-
- [ ] CHK-033 Environment variables documented in README
|
|
162
|
-
- [ ] CHK-034 Database schema documented
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
---
|
|
166
|
-
|
|
167
|
-
## Notes
|
|
168
|
-
|
|
169
|
-
- Checklist items will be merged into acceptance criteria during convert
|
|
170
|
-
- Reference user stories with `[US-XXX]` tags
|
|
171
|
-
- Identify gaps and ambiguities with `[Gap]` and `[Ambiguity]` tags
|
|
172
|
-
- Each item must be independently verifiable
|
|
173
|
-
- Balance between comprehensiveness and practicality
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
# [CHECKLIST TYPE] Checklist: [FEATURE NAME]
|
|
2
|
-
|
|
3
|
-
**Purpose**: [Brief description of what this checklist covers]
|
|
4
|
-
**Created**: [DATE]
|
|
5
|
-
**Feature**: [Link to spec.md or relevant documentation]
|
|
6
|
-
|
|
7
|
-
**Note**: This checklist is generated by the `/relentless.checklist` command based on feature context and requirements.
|
|
8
|
-
|
|
9
|
-
<!--
|
|
10
|
-
============================================================================
|
|
11
|
-
IMPORTANT: The checklist items below are SAMPLE ITEMS for illustration only.
|
|
12
|
-
|
|
13
|
-
The /relentless.checklist command MUST replace these with actual items based on:
|
|
14
|
-
- User's specific checklist request
|
|
15
|
-
- Feature requirements from spec.md
|
|
16
|
-
- Technical context from plan.md
|
|
17
|
-
- Implementation details from tasks.md
|
|
18
|
-
|
|
19
|
-
DO NOT keep these sample items in the generated checklist file.
|
|
20
|
-
============================================================================
|
|
21
|
-
-->
|
|
22
|
-
|
|
23
|
-
## [Category 1]
|
|
24
|
-
|
|
25
|
-
- [ ] CHK001 First checklist item with clear action
|
|
26
|
-
- [ ] CHK002 Second checklist item
|
|
27
|
-
- [ ] CHK003 Third checklist item
|
|
28
|
-
|
|
29
|
-
## [Category 2]
|
|
30
|
-
|
|
31
|
-
- [ ] CHK004 Another category item
|
|
32
|
-
- [ ] CHK005 Item with specific criteria
|
|
33
|
-
- [ ] CHK006 Final item in this category
|
|
34
|
-
|
|
35
|
-
## Notes
|
|
36
|
-
|
|
37
|
-
- Check items off as completed: `[x]`
|
|
38
|
-
- Add comments or findings inline
|
|
39
|
-
- Link to relevant resources or documentation
|
|
40
|
-
- Items are numbered sequentially for easy reference
|