@arvorco/relentless 0.1.6 → 0.1.7
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.
|
@@ -10,69 +10,56 @@ Load the constitution skill and create or update the project constitution at `re
|
|
|
10
10
|
|
|
11
11
|
**Context:** $ARGUMENTS
|
|
12
12
|
|
|
13
|
-
The constitution skill will:
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
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
|
-
Formatting & Style Requirements:
|
|
68
|
-
|
|
69
|
-
- Use Markdown headings exactly as in the template (do not demote/promote levels).
|
|
70
|
-
- Wrap long rationale lines to keep readability (<100 chars ideally) but do not hard enforce with awkward breaks.
|
|
71
|
-
- Keep a single blank line between sections.
|
|
72
|
-
- Avoid trailing whitespace.
|
|
73
|
-
|
|
74
|
-
If the user supplies partial updates (e.g., only one principle revision), still perform validation and version decision steps.
|
|
75
|
-
|
|
76
|
-
If critical info missing (e.g., ratification date truly unknown), insert `TODO(<FIELD_NAME>): explanation` and include in the Sync Impact Report under deferred items.
|
|
77
|
-
|
|
78
|
-
Do not create a new template; always operate on the existing `.specify/memory/constitution.md` file.
|
|
13
|
+
The constitution skill (`.claude/skills/constitution/SKILL.md`) will guide you through:
|
|
14
|
+
|
|
15
|
+
## Process
|
|
16
|
+
|
|
17
|
+
1. **Gather Information**: Ask about project philosophy and standards
|
|
18
|
+
- Project identity (name, languages, tech stack)
|
|
19
|
+
- Testing approach (TDD, coverage requirements)
|
|
20
|
+
- Code quality (linting, checks, reviews)
|
|
21
|
+
- Architecture principles (patterns, modularity)
|
|
22
|
+
- Version control (branches, commits, CI/CD)
|
|
23
|
+
|
|
24
|
+
2. **Generate Constitution**: Create personalized governance document
|
|
25
|
+
- Load template from `.claude/skills/constitution/templates/constitution-template.md`
|
|
26
|
+
- Replace all placeholders with concrete values from user answers
|
|
27
|
+
- Ensure MUST/SHOULD rules are clear and testable
|
|
28
|
+
- Set version 1.0.0 for new, increment semantically for updates
|
|
29
|
+
- Add ratification date and governance procedures
|
|
30
|
+
|
|
31
|
+
3. **Validate**: Check completeness
|
|
32
|
+
- No placeholder tokens remain
|
|
33
|
+
- All dates in ISO format (YYYY-MM-DD)
|
|
34
|
+
- Principles are declarative and testable
|
|
35
|
+
- Version follows semver (X.Y.Z)
|
|
36
|
+
|
|
37
|
+
4. **Save**: Write to `relentless/constitution.md`
|
|
38
|
+
|
|
39
|
+
5. **Report**: Summarize what was created
|
|
40
|
+
- Version number
|
|
41
|
+
- Number of principles defined
|
|
42
|
+
- Key MUST/SHOULD rules
|
|
43
|
+
- Next steps: "Now create your first feature with `/relentless.specify`"
|
|
44
|
+
|
|
45
|
+
## Updating Existing Constitution
|
|
46
|
+
|
|
47
|
+
If `relentless/constitution.md` exists:
|
|
48
|
+
1. Load current version
|
|
49
|
+
2. Ask what needs to change
|
|
50
|
+
3. Increment version appropriately:
|
|
51
|
+
- **MAJOR**: Breaking changes to principles
|
|
52
|
+
- **MINOR**: New principles added
|
|
53
|
+
- **PATCH**: Clarifications, typo fixes
|
|
54
|
+
4. Update LAST_AMENDED_DATE to today
|
|
55
|
+
5. Add amendment notes
|
|
56
|
+
|
|
57
|
+
## Key Points
|
|
58
|
+
|
|
59
|
+
- Constitution saved to `relentless/constitution.md` (project root level)
|
|
60
|
+
- Foundation for all feature work - reference during specification and planning
|
|
61
|
+
- Source of truth for project standards and governance
|
|
62
|
+
- MUST rules are enforced, SHOULD rules are best practices
|
|
63
|
+
- Follow the constitution skill's step-by-step process exactly
|
|
64
|
+
|
|
65
|
+
**After establishing your constitution, create your first feature with `/relentless.specify`**
|
|
@@ -14,241 +14,53 @@ Load the specify skill and create a feature specification in `relentless/feature
|
|
|
14
14
|
|
|
15
15
|
**Feature Description:** $ARGUMENTS
|
|
16
16
|
|
|
17
|
-
The specify skill will:
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
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
|
-
3. Load `.specify/templates/spec-template.md` to understand required sections.
|
|
68
|
-
|
|
69
|
-
4. Follow this execution flow:
|
|
70
|
-
|
|
71
|
-
1. Parse user description from Input
|
|
72
|
-
If empty: ERROR "No feature description provided"
|
|
73
|
-
2. Extract key concepts from description
|
|
74
|
-
Identify: actors, actions, data, constraints
|
|
75
|
-
3. For unclear aspects:
|
|
76
|
-
- Make informed guesses based on context and industry standards
|
|
77
|
-
- Only mark with [NEEDS CLARIFICATION: specific question] if:
|
|
78
|
-
- The choice significantly impacts feature scope or user experience
|
|
79
|
-
- Multiple reasonable interpretations exist with different implications
|
|
80
|
-
- No reasonable default exists
|
|
81
|
-
- **LIMIT: Maximum 3 [NEEDS CLARIFICATION] markers total**
|
|
82
|
-
- Prioritize clarifications by impact: scope > security/privacy > user experience > technical details
|
|
83
|
-
4. Fill User Scenarios & Testing section
|
|
84
|
-
If no clear user flow: ERROR "Cannot determine user scenarios"
|
|
85
|
-
5. Generate Functional Requirements
|
|
86
|
-
Each requirement must be testable
|
|
87
|
-
Use reasonable defaults for unspecified details (document assumptions in Assumptions section)
|
|
88
|
-
6. Define Success Criteria
|
|
89
|
-
Create measurable, technology-agnostic outcomes
|
|
90
|
-
Include both quantitative metrics (time, performance, volume) and qualitative measures (user satisfaction, task completion)
|
|
91
|
-
Each criterion must be verifiable without implementation details
|
|
92
|
-
7. Identify Key Entities (if data involved)
|
|
93
|
-
8. Return: SUCCESS (spec ready for planning)
|
|
94
|
-
|
|
95
|
-
5. Write the specification to SPEC_FILE using the template structure, replacing placeholders with concrete details derived from the feature description (arguments) while preserving section order and headings.
|
|
96
|
-
|
|
97
|
-
6. **Specification Quality Validation**: After writing the initial spec, validate it against quality criteria:
|
|
98
|
-
|
|
99
|
-
a. **Create Spec Quality Checklist**: Generate a checklist file at `FEATURE_DIR/checklists/requirements.md` using the checklist template structure with these validation items:
|
|
100
|
-
|
|
101
|
-
```markdown
|
|
102
|
-
# Specification Quality Checklist: [FEATURE NAME]
|
|
103
|
-
|
|
104
|
-
**Purpose**: Validate specification completeness and quality before proceeding to planning
|
|
105
|
-
**Created**: [DATE]
|
|
106
|
-
**Feature**: [Link to spec.md]
|
|
107
|
-
|
|
108
|
-
## Content Quality
|
|
109
|
-
|
|
110
|
-
- [ ] No implementation details (languages, frameworks, APIs)
|
|
111
|
-
- [ ] Focused on user value and business needs
|
|
112
|
-
- [ ] Written for non-technical stakeholders
|
|
113
|
-
- [ ] All mandatory sections completed
|
|
114
|
-
|
|
115
|
-
## Requirement Completeness
|
|
116
|
-
|
|
117
|
-
- [ ] No [NEEDS CLARIFICATION] markers remain
|
|
118
|
-
- [ ] Requirements are testable and unambiguous
|
|
119
|
-
- [ ] Success criteria are measurable
|
|
120
|
-
- [ ] Success criteria are technology-agnostic (no implementation details)
|
|
121
|
-
- [ ] All acceptance scenarios are defined
|
|
122
|
-
- [ ] Edge cases are identified
|
|
123
|
-
- [ ] Scope is clearly bounded
|
|
124
|
-
- [ ] Dependencies and assumptions identified
|
|
125
|
-
|
|
126
|
-
## Feature Readiness
|
|
127
|
-
|
|
128
|
-
- [ ] All functional requirements have clear acceptance criteria
|
|
129
|
-
- [ ] User scenarios cover primary flows
|
|
130
|
-
- [ ] Feature meets measurable outcomes defined in Success Criteria
|
|
131
|
-
- [ ] No implementation details leak into specification
|
|
132
|
-
|
|
133
|
-
## Notes
|
|
134
|
-
|
|
135
|
-
- Items marked incomplete require spec updates before `/relentless.clarify` or `/relentless.plan`
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
b. **Run Validation Check**: Review the spec against each checklist item:
|
|
139
|
-
- For each item, determine if it passes or fails
|
|
140
|
-
- Document specific issues found (quote relevant spec sections)
|
|
141
|
-
|
|
142
|
-
c. **Handle Validation Results**:
|
|
143
|
-
|
|
144
|
-
- **If all items pass**: Mark checklist complete and proceed to step 6
|
|
145
|
-
|
|
146
|
-
- **If items fail (excluding [NEEDS CLARIFICATION])**:
|
|
147
|
-
1. List the failing items and specific issues
|
|
148
|
-
2. Update the spec to address each issue
|
|
149
|
-
3. Re-run validation until all items pass (max 3 iterations)
|
|
150
|
-
4. If still failing after 3 iterations, document remaining issues in checklist notes and warn user
|
|
151
|
-
|
|
152
|
-
- **If [NEEDS CLARIFICATION] markers remain**:
|
|
153
|
-
1. Extract all [NEEDS CLARIFICATION: ...] markers from the spec
|
|
154
|
-
2. **LIMIT CHECK**: If more than 3 markers exist, keep only the 3 most critical (by scope/security/UX impact) and make informed guesses for the rest
|
|
155
|
-
3. For each clarification needed (max 3), present options to user in this format:
|
|
156
|
-
|
|
157
|
-
```markdown
|
|
158
|
-
## Question [N]: [Topic]
|
|
159
|
-
|
|
160
|
-
**Context**: [Quote relevant spec section]
|
|
161
|
-
|
|
162
|
-
**What we need to know**: [Specific question from NEEDS CLARIFICATION marker]
|
|
163
|
-
|
|
164
|
-
**Suggested Answers**:
|
|
165
|
-
|
|
166
|
-
| Option | Answer | Implications |
|
|
167
|
-
|--------|--------|--------------|
|
|
168
|
-
| A | [First suggested answer] | [What this means for the feature] |
|
|
169
|
-
| B | [Second suggested answer] | [What this means for the feature] |
|
|
170
|
-
| C | [Third suggested answer] | [What this means for the feature] |
|
|
171
|
-
| Custom | Provide your own answer | [Explain how to provide custom input] |
|
|
172
|
-
|
|
173
|
-
**Your choice**: _[Wait for user response]_
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
4. **CRITICAL - Table Formatting**: Ensure markdown tables are properly formatted:
|
|
177
|
-
- Use consistent spacing with pipes aligned
|
|
178
|
-
- Each cell should have spaces around content: `| Content |` not `|Content|`
|
|
179
|
-
- Header separator must have at least 3 dashes: `|--------|`
|
|
180
|
-
- Test that the table renders correctly in markdown preview
|
|
181
|
-
5. Number questions sequentially (Q1, Q2, Q3 - max 3 total)
|
|
182
|
-
6. Present all questions together before waiting for responses
|
|
183
|
-
7. Wait for user to respond with their choices for all questions (e.g., "Q1: A, Q2: Custom - [details], Q3: B")
|
|
184
|
-
8. Update the spec by replacing each [NEEDS CLARIFICATION] marker with the user's selected or provided answer
|
|
185
|
-
9. Re-run validation after all clarifications are resolved
|
|
186
|
-
|
|
187
|
-
d. **Update Checklist**: After each validation iteration, update the checklist file with current pass/fail status
|
|
188
|
-
|
|
189
|
-
7. Report completion with branch name, spec file path, checklist results, and readiness for the next phase (`/relentless.clarify` or `/relentless.plan`).
|
|
190
|
-
|
|
191
|
-
**NOTE:** The script creates and checks out the new branch and initializes the spec file before writing.
|
|
192
|
-
|
|
193
|
-
## General Guidelines
|
|
194
|
-
|
|
195
|
-
## Quick Guidelines
|
|
196
|
-
|
|
197
|
-
- Focus on **WHAT** users need and **WHY**.
|
|
198
|
-
- Avoid HOW to implement (no tech stack, APIs, code structure).
|
|
199
|
-
- Written for business stakeholders, not developers.
|
|
200
|
-
- DO NOT create any checklists that are embedded in the spec. That will be a separate command.
|
|
201
|
-
|
|
202
|
-
### Section Requirements
|
|
203
|
-
|
|
204
|
-
- **Mandatory sections**: Must be completed for every feature
|
|
205
|
-
- **Optional sections**: Include only when relevant to the feature
|
|
206
|
-
- When a section doesn't apply, remove it entirely (don't leave as "N/A")
|
|
207
|
-
|
|
208
|
-
### For AI Generation
|
|
209
|
-
|
|
210
|
-
When creating this spec from a user prompt:
|
|
211
|
-
|
|
212
|
-
1. **Make informed guesses**: Use context, industry standards, and common patterns to fill gaps
|
|
213
|
-
2. **Document assumptions**: Record reasonable defaults in the Assumptions section
|
|
214
|
-
3. **Limit clarifications**: Maximum 3 [NEEDS CLARIFICATION] markers - use only for critical decisions that:
|
|
215
|
-
- Significantly impact feature scope or user experience
|
|
216
|
-
- Have multiple reasonable interpretations with different implications
|
|
217
|
-
- Lack any reasonable default
|
|
218
|
-
4. **Prioritize clarifications**: scope > security/privacy > user experience > technical details
|
|
219
|
-
5. **Think like a tester**: Every vague requirement should fail the "testable and unambiguous" checklist item
|
|
220
|
-
6. **Common areas needing clarification** (only if no reasonable default exists):
|
|
221
|
-
- Feature scope and boundaries (include/exclude specific use cases)
|
|
222
|
-
- User types and permissions (if multiple conflicting interpretations possible)
|
|
223
|
-
- Security/compliance requirements (when legally/financially significant)
|
|
224
|
-
|
|
225
|
-
**Examples of reasonable defaults** (don't ask about these):
|
|
226
|
-
|
|
227
|
-
- Data retention: Industry-standard practices for the domain
|
|
228
|
-
- Performance targets: Standard web/mobile app expectations unless specified
|
|
229
|
-
- Error handling: User-friendly messages with appropriate fallbacks
|
|
230
|
-
- Authentication method: Standard session-based or OAuth2 for web apps
|
|
231
|
-
- Integration patterns: RESTful APIs unless specified otherwise
|
|
232
|
-
|
|
233
|
-
### Success Criteria Guidelines
|
|
234
|
-
|
|
235
|
-
Success criteria must be:
|
|
236
|
-
|
|
237
|
-
1. **Measurable**: Include specific metrics (time, percentage, count, rate)
|
|
238
|
-
2. **Technology-agnostic**: No mention of frameworks, languages, databases, or tools
|
|
239
|
-
3. **User-focused**: Describe outcomes from user/business perspective, not system internals
|
|
240
|
-
4. **Verifiable**: Can be tested/validated without knowing implementation details
|
|
241
|
-
|
|
242
|
-
**Good examples**:
|
|
243
|
-
|
|
244
|
-
- "Users can complete checkout in under 3 minutes"
|
|
245
|
-
- "System supports 10,000 concurrent users"
|
|
246
|
-
- "95% of searches return results in under 1 second"
|
|
247
|
-
- "Task completion rate improves by 40%"
|
|
248
|
-
|
|
249
|
-
**Bad examples** (implementation-focused):
|
|
250
|
-
|
|
251
|
-
- "API response time is under 200ms" (too technical, use "Users see results instantly")
|
|
252
|
-
- "Database can handle 1000 TPS" (implementation detail, use user-facing metric)
|
|
253
|
-
- "React components render efficiently" (framework-specific)
|
|
254
|
-
- "Redis cache hit rate above 80%" (technology-specific)
|
|
17
|
+
The specify skill (`.claude/skills/specify/SKILL.md`) will guide you through:
|
|
18
|
+
|
|
19
|
+
## Process
|
|
20
|
+
|
|
21
|
+
1. **Create Feature Structure**
|
|
22
|
+
- Generate short name (2-4 words) from description
|
|
23
|
+
- Check existing branches to find next number
|
|
24
|
+
- Run `.claude/skills/specify/scripts/bash/create-new-feature.sh --json "FEATURE_DESCRIPTION"`
|
|
25
|
+
- Parse JSON output for BRANCH_NAME, SPEC_FILE, FEATURE_DIR
|
|
26
|
+
|
|
27
|
+
2. **Load Context**
|
|
28
|
+
- Read `relentless/constitution.md` for governance rules
|
|
29
|
+
- Note MUST/SHOULD requirements for specifications
|
|
30
|
+
- Load spec template from `.claude/skills/specify/templates/spec-template.md`
|
|
31
|
+
|
|
32
|
+
3. **Generate Specification**
|
|
33
|
+
- Extract key concepts: actors, actions, data, constraints
|
|
34
|
+
- Make informed assumptions (document in Assumptions section)
|
|
35
|
+
- Limit [NEEDS CLARIFICATION] markers to max 3 critical items
|
|
36
|
+
- Write complete spec to SPEC_FILE
|
|
37
|
+
|
|
38
|
+
4. **Validate Quality**
|
|
39
|
+
- All sections completed with concrete details
|
|
40
|
+
- User scenarios are clear and testable
|
|
41
|
+
- Functional requirements are measurable
|
|
42
|
+
- Success criteria are defined
|
|
43
|
+
- Assumptions documented
|
|
44
|
+
|
|
45
|
+
5. **Report Completion**
|
|
46
|
+
- Feature number and name
|
|
47
|
+
- Branch created
|
|
48
|
+
- Spec file location
|
|
49
|
+
- Next steps: `/relentless.plan` or `/relentless.clarify`
|
|
50
|
+
|
|
51
|
+
## Key Points
|
|
52
|
+
|
|
53
|
+
- **Branch naming**: `NNN-feature-name` (e.g., `003-user-auth`)
|
|
54
|
+
- **Directory structure**: `relentless/features/NNN-feature-name/`
|
|
55
|
+
- **Spec file**: `relentless/features/NNN-feature-name/spec.md`
|
|
56
|
+
- **Auto-numbering**: Script checks existing branches and uses next available number
|
|
57
|
+
- **Quality focus**: Make reasonable assumptions, minimize clarifications
|
|
58
|
+
- **Constitution compliance**: Follow project governance rules
|
|
59
|
+
|
|
60
|
+
## After Specification
|
|
61
|
+
|
|
62
|
+
- Run `/relentless.clarify` if ambiguities need resolving
|
|
63
|
+
- Run `/relentless.plan` to create technical implementation plan
|
|
64
|
+
- Run `/relentless.tasks` to generate user stories and tasks
|
|
65
|
+
|
|
66
|
+
**Follow the specify skill's step-by-step process exactly.**
|
package/README.md
CHANGED
|
@@ -71,9 +71,9 @@ relentless run --feature 001-user-auth --tui
|
|
|
71
71
|
|
|
72
72
|
See [Supported Agents](#supported-agents) section for detailed workflows per agent.
|
|
73
73
|
|
|
74
|
-
###
|
|
74
|
+
### Ralph Wiggum Method (Classic Workflow)
|
|
75
75
|
|
|
76
|
-
You can still use the original workflow with direct PRD creation:
|
|
76
|
+
You can still use the original Ralph Wiggum workflow with direct PRD creation:
|
|
77
77
|
|
|
78
78
|
```bash
|
|
79
79
|
# 1. Install and initialize
|