|
|
|
|
@@ -19,11 +19,32 @@ The text the user typed after `/speckit.specify` in the triggering message **is*
|
|
|
|
|
|
|
|
|
|
Given that feature description, do this:
|
|
|
|
|
|
|
|
|
|
1. Run the script `{SCRIPT}` from repo root and parse its JSON output for BRANCH_NAME and SPEC_FILE. All file paths must be absolute.
|
|
|
|
|
**IMPORTANT** You must only ever run this script once. The JSON is provided in the terminal as output - always refer to it to get the actual content you're looking for. 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").
|
|
|
|
|
2. Load `templates/spec-template.md` to understand required sections.
|
|
|
|
|
1. **Generate a concise short name** (2-4 words) for the branch:
|
|
|
|
|
- Analyze the feature description and extract the most meaningful keywords
|
|
|
|
|
- Create a 2-4 word short name that captures the essence of the feature
|
|
|
|
|
- Use action-noun format when possible (e.g., "add-user-auth", "fix-payment-bug")
|
|
|
|
|
- Preserve technical terms and acronyms (OAuth2, API, JWT, etc.)
|
|
|
|
|
- Keep it concise but descriptive enough to understand the feature at a glance
|
|
|
|
|
- Examples:
|
|
|
|
|
- "I want to add user authentication" → "user-auth"
|
|
|
|
|
- "Implement OAuth2 integration for the API" → "oauth2-api-integration"
|
|
|
|
|
- "Create a dashboard for analytics" → "analytics-dashboard"
|
|
|
|
|
- "Fix payment processing timeout bug" → "fix-payment-timeout"
|
|
|
|
|
|
|
|
|
|
3. Follow this execution flow:
|
|
|
|
|
2. Run the script `{SCRIPT}` from repo root **with the short-name argument** and parse its JSON output for BRANCH_NAME and SPEC_FILE. All file paths must be absolute.
|
|
|
|
|
|
|
|
|
|
**IMPORTANT**:
|
|
|
|
|
|
|
|
|
|
- Append the short-name argument to the `{SCRIPT}` command with the 2-4 word short name you created in step 1
|
|
|
|
|
- Bash: `--short-name "your-generated-short-name"`
|
|
|
|
|
- PowerShell: `-ShortName "your-generated-short-name"`
|
|
|
|
|
- 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")
|
|
|
|
|
- You must only ever run this script once
|
|
|
|
|
- The JSON is provided in the terminal as output - always refer to it to get the actual content you're looking for
|
|
|
|
|
|
|
|
|
|
3. Load `templates/spec-template.md` to understand required sections.
|
|
|
|
|
|
|
|
|
|
4. Follow this execution flow:
|
|
|
|
|
|
|
|
|
|
1. Parse user description from Input
|
|
|
|
|
If empty: ERROR "No feature description provided"
|
|
|
|
|
@@ -49,9 +70,9 @@ Given that feature description, do this:
|
|
|
|
|
7. Identify Key Entities (if data involved)
|
|
|
|
|
8. Return: SUCCESS (spec ready for planning)
|
|
|
|
|
|
|
|
|
|
4. 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.
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
5. **Specification Quality Validation**: After writing the initial spec, validate it against quality criteria:
|
|
|
|
|
6. **Specification Quality Validation**: After writing the initial spec, validate it against quality criteria:
|
|
|
|
|
|
|
|
|
|
a. **Create Spec Quality Checklist**: Generate a checklist file at `FEATURE_DIR/checklists/requirements.md` using the checklist template structure with these validation items:
|
|
|
|
|
|
|
|
|
|
@@ -143,7 +164,7 @@ Given that feature description, do this:
|
|
|
|
|
|
|
|
|
|
d. **Update Checklist**: After each validation iteration, update the checklist file with current pass/fail status
|
|
|
|
|
|
|
|
|
|
6. Report completion with branch name, spec file path, checklist results, and readiness for the next phase (`/speckit.clarify` or `/speckit.plan`).
|
|
|
|
|
7. Report completion with branch name, spec file path, checklist results, and readiness for the next phase (`/speckit.clarify` or `/speckit.plan`).
|
|
|
|
|
|
|
|
|
|
**NOTE:** The script creates and checks out the new branch and initializes the spec file before writing.
|
|
|
|
|
|
|
|
|
|
@@ -209,3 +230,4 @@ Success criteria must be:
|
|
|
|
|
- "Database can handle 1000 TPS" (implementation detail, use user-facing metric)
|
|
|
|
|
- "React components render efficiently" (framework-specific)
|
|
|
|
|
- "Redis cache hit rate above 80%" (technology-specific)
|
|
|
|
|
|
|
|
|
|
|