Skip to content

Commit 1ecedb9

Browse files
zaheer15351Augment Agent
authored andcommitted
fix(checklist): clarify file handling behavior for append vs create (github#1556)
* fix(checklist): clarify file handling behavior for append vs create Resolves contradictory instructions in checklist.md lines 97-99 where the template stated both 'append to existing file' and 'creates a NEW file'. Changes: - Clarified that if file doesn't exist, create new with CHK001 - If file exists, append new items continuing from last CHK ID - Emphasized preservation of existing content (never delete/replace) Co-authored-by: Augment Agent <noreply@augmentcode.com> * fix(checklist): align report language with append behavior --------- Co-authored-by: Augment Agent <noreply@augmentcode.com>
1 parent 59edb5f commit 1ecedb9

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

templates/commands/checklist.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,10 @@ You **MUST** consider the user input before proceeding (if not empty).
113113
- Generate unique checklist filename:
114114
- Use short, descriptive name based on domain (e.g., `ux.md`, `api.md`, `security.md`)
115115
- Format: `[domain].md`
116-
- If file exists, append to existing file
117-
- Number items sequentially starting from CHK001
118-
- Each `/speckit.checklist` run creates a NEW file (never overwrites existing checklists)
116+
- File handling behavior:
117+
- If file does NOT exist: Create new file and number items starting from CHK001
118+
- If file exists: Append new items to existing file, continuing from the last CHK ID (e.g., if last item is CHK015, start new items at CHK016)
119+
- Never delete or replace existing checklist content - always preserve and append
119120

120121
**CORE PRINCIPLE - Test the Requirements, Not the Implementation**:
121122
Every checklist item MUST evaluate the REQUIREMENTS THEMSELVES for:
@@ -227,13 +228,13 @@ You **MUST** consider the user input before proceeding (if not empty).
227228

228229
6. **Structure Reference**: Generate the checklist following the canonical template in `templates/checklist-template.md` for title, meta section, category headings, and ID formatting. If template is unavailable, use: H1 title, purpose/created meta lines, `##` category sections containing `- [ ] CHK### <requirement item>` lines with globally incrementing IDs starting at CHK001.
229230

230-
7. **Report**: Output full path to created checklist, item count, and remind user that each run creates a new file. Summarize:
231+
7. **Report**: Output full path to checklist file, item count, and summarize whether the run created a new file or appended to an existing one. Summarize:
231232
- Focus areas selected
232233
- Depth level
233234
- Actor/timing
234235
- Any explicit user-specified must-have items incorporated
235236

236-
**Important**: Each `/speckit.checklist` command invocation creates a checklist file using short, descriptive names unless file already exists. This allows:
237+
**Important**: Each `/speckit.checklist` command invocation uses a short, descriptive checklist filename and either creates a new file or appends to an existing one. This allows:
237238

238239
- Multiple checklists of different types (e.g., `ux.md`, `test.md`, `security.md`)
239240
- Simple, memorable filenames that indicate checklist purpose

0 commit comments

Comments
 (0)