Skip to content

Commit 62cdee3

Browse files
feat: add PRD file existence check to create_documentation workflow step
- Added validation to verify docs/product/PRD.md exists before marking documentation complete - Updated create_documentation handler to check for PRD file - Updated tests to verify PRD check is working correctly - Updated README.md with documentation about PRD requirement - Ensures all projects maintain current PRD describing product goals and requirements
1 parent a7f2b28 commit 62cdee3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,13 +353,18 @@ The tool will:
353353
2. `create_tests`
354354
3. `run_tests` with `testsPassed`, `testCommand`, and optional `testDetails`
355355
4. `create_documentation` with `documentationType` and `documentationSummary`
356+
- **Requires**: `docs/product/PRD.md` must exist before documentation can be marked complete
356357
5. `check_ready_to_commit`
357358
6. `commit_and_push` with `commitMessage` and optional `branch`
358359
7. `perform_release` with `releaseCommand`, plus optional `releaseNotes`, `releaseType`, and `preset`
359360
8. `complete_task` reusing `commitMessage`
360361

361362
All arguments except the optional flags are required and must be non-empty strings.
362363

364+
### Documentation Requirements
365+
366+
The `create_documentation` step enforces that a PRD (Product Requirements Document) exists at `docs/product/PRD.md` before documentation can be marked as complete. This ensures all projects maintain a current PRD that describes the product's goals, features, and requirements.
367+
363368
## 🚫 Releasing Without the Workflow Steps
364369

365370
The package ships with a release guard (`release-wrapper.js`) that backs the `npm run release:*` scripts. The guard refuses to run unless:

0 commit comments

Comments
 (0)