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
## Description
This pull request updates the implementation instructions in
`.github/prompts/implement.prompt.md` to improve task tracking and
clarify how pull request descriptions should be managed. The main focus
is on making task progress more visible in real-time and ensuring the PR
description is always ready to be used as release notes.
**Task tracking and status updates:**
* Added a critical requirement to update task status immediately after
each task is completed:
* Mark the task as `[X]` in `tasks.md` and update the PR description
checkbox for each completed task.
* Updates must be made task-by-task, not at the end.
* Provided guidance for using GitHub tools or `gh pr edit` to update the
PR description, ensuring real-time visibility of task progress.
**Pull request description management:**
* Changed instructions to require replacing the entire PR description
with release notes:
* The existing PR description, including the task list, must be cleared
and replaced with release notes.
* This ensures the PR description is immediately ready to be used as
GitHub Release notes upon merging.
* Updated the example command to clarify that the PR description should
be replaced with release notes.
## 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
2. Run [`.specify/scripts/powershell/check-prerequisites.ps1 -Json -RequireTasks -IncludeTasks`](../../.specify/scripts/powershell/check-prerequisites.ps1) from repo root and parse FEATURE_DIR and AVAILABLE_DOCS list. All paths must be absolute.
38
-
39
36
3. Load and analyze the implementation context:
40
37
-**REQUIRED**: Read tasks.md for the complete task list and execution plan
41
38
-**REQUIRED**: Read plan.md for tech stack, architecture, and file structure
42
39
-**IF EXISTS**: Read data-model.md for entities and relationships
43
40
-**IF EXISTS**: Read contracts/ for API specifications and test requirements
44
41
-**IF EXISTS**: Read research.md for technical decisions and constraints
45
42
-**IF EXISTS**: Read quickstart.md for integration scenarios
-**Resume from last incomplete task**: Start with first [] task found
@@ -62,36 +57,37 @@ $ARGUMENTS
62
57
-**Follow TDD approach**: Execute test tasks before their corresponding implementation tasks
63
58
-**File-based coordination**: Tasks affecting the same files must run sequentially
64
59
-**Validation checkpoints**: Verify each phase completion before proceeding
65
-
66
60
6. Implementation execution rules:
67
61
-**Setup first**: Initialize project structure, dependencies, and configuration
68
62
-**Tests before code**: If you need to write tests for contracts, entities, and integration scenarios
69
63
-**Core development**: Implement models, services, CLI commands, and endpoints
70
64
-**Integration work**: Database connections, middleware, logging, and external services
71
65
-**Polish and validation**: Unit tests, performance optimization, and documentation
72
-
73
66
7. Progress tracking and error handling:
74
67
- Report progress after each completed task
75
68
- Halt execution if any non-parallel task fails
76
69
- For parallel tasks [P], continue with successful tasks and report failed ones
77
70
- Provide clear error messages with context for debugging
78
71
- Suggest next steps if implementation cannot proceed
79
-
-**IMPORTANT**: For completed tasks, make sure to mark the task as [X] in the tasks file.
80
-
72
+
-**CRITICAL - Update task status immediately after completion**:
73
+
* After completing each task, mark it as [X] in tasks.md
74
+
* Update the PR description to mark the corresponding task checkbox from `- [ ] T###:` to `- [X] T###:`
75
+
* This MUST be done task-by-task as you progress, not at the end
76
+
* If GitHub tools are available, use them to update the PR description
77
+
* If not available, use: `gh pr edit <PR-number> --body "<updated-description>"`
78
+
* Ensure task progress is visible in real-time to users watching the PR
81
79
8. Completion validation:
82
80
- Verify all required tasks are completed
83
81
- Check that implemented features match the original specification
84
82
- Validate that tests pass and coverage meets requirements
85
83
- Confirm the implementation follows the technical plan
86
84
- Report final status with summary of completed work
87
-
88
85
9. Update the constitution:
89
86
- Read the [Constitution](../../.specify/memory/constitution.md) file.
90
87
- Read the [constitution prompt](./constitution.prompt.md) for guidance on how to update the constitution.
91
88
- Update the constitution file with details on what has been implemented in this PR
92
89
- Document the functionality that was added or changed, remove the sections that are no longer relevant
93
90
- Ensure the constitution reflects the current state of the codebase
94
-
95
91
10. Update the CHANGELOG:
96
92
-**Locate or create CHANGELOG.md** in the repository root
97
93
-**Add a new entry** for this feature/change following the Keep a Changelog format
@@ -109,7 +105,6 @@ $ARGUMENTS
109
105
* Include brief usage examples where helpful
110
106
* Link to the PR or issue: `[#<issue-number>]`
111
107
-**Keep it concise**: Focus on user-impacting changes, not internal refactoring details
112
-
113
108
11. Final commit and push:
114
109
-**Stage all implemented changes** including:
115
110
* All source code files created or modified
@@ -123,7 +118,6 @@ $ARGUMENTS
123
118
* Include reference to issue: `Fixes #<issue-number>`
124
119
-**Push the branch** to remote
125
120
- Verify the push completed successfully
126
-
127
121
12. Update PR description with release notes:
128
122
-**Determine workflow mode and target repository**:
129
123
- Check if `.fork-info.json` exists in the feature directory (same directory as spec.md)
@@ -141,7 +135,6 @@ $ARGUMENTS
141
135
-**Retrieve the issue title**: Get the title from the linked GitHub issue (created in `/specify`) from the target repository
142
136
-**Use the same title for the PR**: Verify the PR title matches the issue title exactly. If they differ, update the PR title to match the issue.
143
137
- If unable to retrieve the issue title, determine the PR type and icon based on the changes:
144
-
145
138
| Type of change | Icon | Label |
146
139
|-|-|-|
147
140
| Docs | 📖 | Docs |
@@ -150,9 +143,10 @@ $ARGUMENTS
150
143
| Patch | 🩹 | Patch |
151
144
| Feature | 🚀 | Minor |
152
145
| Breaking change | 🌟 | Major |
153
-
154
146
- Fallback PR title format (if issue title unavailable): `<Icon> [Type of change]: <Short description>`
155
-
-**Write PR description as a release note**:
147
+
-**REPLACE the entire PR description with release notes**:
148
+
***IMPORTANT**: Clear the existing PR description completely (including task list) and replace it with the release notes
149
+
* This ensures the PR description is ready to be used as GitHub Release notes when merged to main
156
150
***Opening summary** (1-2 paragraphs):
157
151
- Start with what was accomplished in user-focused language
158
152
- Write in past tense: "Added...", "Improved...", "Fixed..."
@@ -183,15 +177,13 @@ $ARGUMENTS
183
177
-**Apply appropriate label(s)** based on the type of change
184
178
-**Link the PR** to the associated issue
185
179
-**Update `.fork-info.json`** (if it exists) with the latest PR number (if not already present)
186
-
187
180
**GitHub Integration**: If GitHub tools or integrations are available (such as GitHub MCP Server or other GitHub integrations), use them to update the PR description in the target repository. If not available, provide this fallback command:
0 commit comments