You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
📝[Enhancement]: Add structured reporting during the process (#197)
## Description
This pull request updates the workflow prompts for the GitHub automation
scripts to improve user communication and reporting. The main change is
that each major phase (specification, clarification, planning, task
generation, and analysis) now posts a clear status comment to the GitHub
issue, summarizing progress and next steps for users. Additionally, the
analysis and clarification steps now produce more structured, readable
markdown reports.
Key improvements include:
**User Communication Enhancements:**
* Each major workflow step (`specify`, `clarify`, `plan`, `tasks`,
`analyze`) now posts a standardized status comment to the issue, clearly
indicating completion and next recommended actions.
[[1]](diffhunk://#diff-fa401fef0198b14e6b962bab378aefea7dac6156cbe91dc0ccf1f4de2a56e0fdL140-R142)
[[2]](diffhunk://#diff-c0d19cb5a033f16f5989ac19b6c95af3bce61c8e84952ffb48009ed901264115L145-R162)
[[3]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L141-R144)
[[4]](diffhunk://#diff-dae60ede84de8dbfbeaa4633505d0c420ce25288ca04d74ac85b28454fad0734L112-R114)
[[5]](diffhunk://#diff-149f5825020c21985a8967be1c77807826b4c395a3153ee54414ad90b862ffbbL97-R136)
**Analysis and Clarification Reporting:**
* The analysis step now posts a detailed markdown comment with tables
grouped by severity, a summary, and explicit next actions, making
findings easier to review and act upon.
* The clarification step now posts a markdown summary table of questions
and answers if any were asked, improving traceability of clarifications.
**Process and Flow Improvements:**
* The planning step now checks for clarifications before proceeding,
pausing if ambiguous areas remain and instructing the user on how to
resolve them.
* Each phase's reporting is reorganized to ensure the status comment is
posted before the detailed completion report, improving user guidance
and flow.
[[1]](diffhunk://#diff-fa401fef0198b14e6b962bab378aefea7dac6156cbe91dc0ccf1f4de2a56e0fdL140-R142)
[[2]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L141-R144)
[[3]](diffhunk://#diff-dae60ede84de8dbfbeaa4633505d0c420ce25288ca04d74ac85b28454fad0734L112-R114)
These changes collectively make the workflow more transparent,
actionable, and user-friendly.
## Type of change
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]
## Checklist
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
Copy file name to clipboardExpand all lines: .github/instructions/md.instructions.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Markdown style guidelines for consistency across documentation.
5
5
6
6
# Markdown Style Guidelines
7
7
8
-
This document defines the markdown style guidelines for all markdown files in this repository. These rules follow common markdown linter best practices and ensure consistency across documentation.
8
+
This document defines the Markdown style guidelines for all Markdown files in this repository. These rules follow common Markdown linter best practices and ensure consistency across documentation.
9
9
10
10
## Headings
11
11
@@ -110,7 +110,7 @@ No blank lines before/after code blocks.
110
110
- Always provide link text in square brackets: `[text](url)`
111
111
- Do not use bare URLs (wrap them: `<https://example.com>`)
112
112
- For internal repository links, use relative paths starting with `./` or `../`
113
-
- Use `.md` extension for links to markdown files
113
+
- Use `.md` extension for links to Markdown files
114
114
115
115
**Good:**
116
116
@@ -252,13 +252,13 @@ See the [logo][logo-img] above.
252
252
253
253
### HTML
254
254
255
-
- Avoid HTML in markdown when possible
256
-
- Use HTML only for features not supported by markdown
255
+
- Avoid HTML in Markdown when possible
256
+
- Use HTML only for features not supported by Markdown
257
257
- Close all HTML tags properly
258
258
259
-
### File Names
259
+
### Filenames
260
260
261
-
- Use lowercase for markdown file names
261
+
- Use lowercase for Markdown filenames
262
262
- Use hyphens (`-`) not underscores (`_`) to separate words
263
263
- Use `.md` extension (not `.markdown`)
264
264
@@ -269,7 +269,7 @@ See the [logo][logo-img] above.
269
269
270
270
## Linting
271
271
272
-
To validate markdown files against these guidelines, use a markdown linter such as:
272
+
To validate Markdown files against these guidelines, use a Markdown linter such as:
- Keep tables concise, limit to 20 findings per severity level
133
+
- If more than 20 findings in a category, add a note: "_(Additional N issues not shown - see full report)_"
134
+
- Include the complete "Next Actions" block with specific recommendations
135
+
136
+
8. At end of report, output a concise Next Actions block:
98
137
- If CRITICAL issues exist: Recommend resolving them before `/implement`.
99
138
- If only LOW/MEDIUM issues: User may proceed, but provide improvement suggestions.
100
139
- Provide explicit command suggestions: e.g., "Run /specify with refinement", "Run /plan to adjust architecture", or "Manually edit tasks.md to add coverage for 'performance-metrics'".
Copy file name to clipboardExpand all lines: .github/prompts/constitution.prompt.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,12 +64,12 @@ Follow this execution flow:
64
64
65
65
3. Draft / Merge updated constitution content:
66
66
- In Iteration Mode, integrate new principles/sections with minimal disruption:
67
-
* Retain stable identifiers (e.g., keep existing principle numbering unless renumbering is explicitly required or gaps introduced by removals).
68
-
* When replacing, either (a) fully substitute content if user confirmed or (b) append revised content and mark old with `DEPRECATED:` prefix plus TODO for removal in a future major version.
69
-
- Replace every placeholder with concrete text (no bracketed tokens left except intentionally retained template slots that the project has chosen not to define yet—explicitly justify any left).
70
-
- Preserve heading hierarchy and comments can be removed once replaced unless they still add clarifying guidance.
71
-
- Ensure each Principle section: succinct name line, paragraph (or bullet list) capturing non‑negotiable rules, explicit rationale if not obvious.
* Retain stable identifiers (e.g., keep existing principle numbering unless renumbering is explicitly required or gaps introduced by removals).
68
+
* When replacing, either (a) fully substitute content if user confirmed or (b) append revised content and mark old with `DEPRECATED:` prefix plus TODO for removal in a future major version.
69
+
- Replace every placeholder with concrete text (no bracketed tokens left except intentionally retained template slots that the project has chosen not to define yet—explicitly justify any left).
70
+
- Preserve heading hierarchy and comments can be removed once replaced unless they still add clarifying guidance.
71
+
- Ensure each Principle section: succinct name line, paragraph (or bullet list) capturing non‑negotiable rules, explicit rationale if not obvious.
4. Consistency propagation checklist (convert prior checklist into active validations):
75
75
- Read [`.specify/templates/plan-template.md`](../../.specify/templates/plan-template.md) and ensure any "Constitution Check" or rules align with updated principles.
Copy file name to clipboardExpand all lines: .github/prompts/plan.prompt.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,7 @@ Given the implementation details provided as an argument, do this:
23
23
-**If exists**: You are ITERATING on an existing plan. User input should guide refinements/additions to the existing plan content.
24
24
-**If not exists**: You are CREATING a new plan from scratch.
25
25
- BEFORE proceeding, inspect FEATURE_SPEC for a `## Clarifications` section with at least one `Session` subheading. If missing or clearly ambiguous areas remain (vague adjectives, unresolved critical choices), PAUSE and instruct the user to run `/clarify` first to reduce rework. Only continue if: (a) Clarifications exist OR (b) an explicit user override is provided (e.g., "proceed without clarification"). Do not attempt to fabricate clarifications yourself.
26
+
26
27
2. Read and analyze the feature specification to understand:
27
28
- The feature requirements and user stories
28
29
- Functional and non-functional requirements
@@ -138,6 +139,8 @@ Given the implementation details provided as an argument, do this:
3. Run the script [`.specify/scripts/powershell/create-new-feature.ps1 -Json -FeatureDescription "$ARGUMENTS" -BranchName "<your-generated-name>"`](../../.specify/scripts/powershell/create-new-feature.ps1) from repo root and parse its JSON output for BRANCH_NAME, SPEC_FILE, and IS_EXISTING_BRANCH. All file paths must be absolute.
54
-
**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.
55
-
**NOTE**
56
-
- The script will prepend an auto-incremented feature number (e.g., `003-`) to your branch name.
57
-
- If you're currently on `main` branch, a new feature branch will be created.
58
-
- If you're already on a feature branch (starts with 3 digits like `001-`, `002-`, etc.), you'll stay on that branch to iterate on the existing feature.
59
-
- This allows you to refine specifications without creating multiple branches for the same feature.
55
+
56
+
**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.
57
+
58
+
**NOTE**
59
+
60
+
- The script will prepend an auto-incremented feature number (e.g., `003-`) to your branch name.
61
+
- If you're currently on `main` branch, a new feature branch will be created.
62
+
- If you're already on a feature branch (starts with 3 digits like `001-`, `002-`, etc.), you'll stay on that branch to iterate on the existing feature.
63
+
- This allows you to refine specifications without creating multiple branches for the same feature.
60
64
61
65
4.**Store fork information (if detected in step 1)**:
62
66
- If the user indicated this is a fork contribution, create a `.fork-info.json` file in the feature directory (same location as SPEC_FILE)
@@ -137,6 +141,8 @@ Given that feature description, do this:
8. Report completion with branch name, spec file path, whether it's a new or updated feature, issue number, target repository (if fork), and readiness for the next phase.
144
+
8.**Post final status comment**: "✅ Specification complete. Ready for clarification with `/clarify` or planning with `/plan`."
145
+
146
+
9. Report completion with branch name, spec file path, whether it's a new or updated feature, issue number, target repository (if fork), and readiness for the next phase.
141
147
142
148
Note: The script handles branch creation/reuse and initializes the spec file before writing.
0 commit comments