fix(checklist): clarify file handling behavior for append vs create#1556
fix(checklist): clarify file handling behavior for append vs create#1556zaheer15351 wants to merge 1 commit intogithub:mainfrom
Conversation
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>
zaheer15351
force-pushed
the
fix/checklist-contradictory-file-handling
branch
from
32ca6e7 to
f91416f
Compare
There was a problem hiding this comment.
Pull request overview
This PR resolves a contradiction in the checklist command documentation where lines 97-99 of templates/commands/checklist.md stated both that files should be appended to when they exist AND that each run creates a NEW file. The changes clarify the actual intended behavior: new files start at CHK001, existing files are appended to (continuing from the last CHK ID), and existing content is never deleted or replaced.
Changes:
- Restructured lines 97-100 to clearly separate the "file does NOT exist" vs "file exists" behaviors
- Added explicit instruction to never delete or replace existing checklist content
- Removed contradictory language about creating NEW files on each run
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - File handling behavior: | ||
| - If file does NOT exist: Create new file and number items starting from CHK001 | ||
| - 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) | ||
| - Never delete or replace existing checklist content - always preserve and append |
There was a problem hiding this comment.
Lines 212 and 218 still contain language that contradicts these clarified file handling rules. Line 212 says "remind user that each run creates a new file", and line 218 says "Each /speckit.checklist command invocation creates a checklist file... unless file already exists". These should be updated to align with the new clarification that existing files are appended to (not that new files are created each time).
1 participant
Resolves contradictory instructions in checklist.md lines 97-99 where the template stated both 'append to existing file' and 'creates a NEW file'.
Changes:
This PR was created with assistance from Augment Agent (Claude).