docs: Document contract task population [doc-updater] - #275
Conversation
Update documentation to reflect changes from commit 5f6ccd9: - Added populate-contract-tasks.py to action/ directory listing in STRUCTURE.md - Added script to action/README.md with description - Added "Task Population" section in SDLC pipeline guide explaining when/how tasks are extracted from plan documents - Added script references to "Key Files" table in pipeline guide The populate-contract-tasks.py script bridges the plan and implement phases by automatically extracting [TASK-X-Y] markers from approved plan documents and populating the contract JSON before implementation begins. Triggered by: 5f6ccd9 Authored-by: egg
There was a problem hiding this comment.
Agent-mode design review: No concerns.
The documented feature (populate-contract-tasks.py) is a pre-processing step that populates structured task data before the implementing agent runs—this is helpful orientation, not problematic pre-fetching. The structured output (contract JSON) is for machine consumption by downstream pipeline steps, which is the appropriate use case per the guidelines.
— Authored by egg
|
egg agent-mode-design completed. View run logs |
There was a problem hiding this comment.
Documentation Review
This PR adds documentation for the populate-contract-tasks.py script introduced in #274. I've verified that the referenced files exist and the documentation broadly reflects the actual implementation.
Minor Inaccuracy
In docs/guides/sdlc-pipeline.md, the Task Population section states:
- Validates the contract against the JSON schema
This is not precisely accurate. The script uses Pydantic model validation (Contract.model_validate()), not JSON schema validation. While the Pydantic models are designed to match the JSON schema in .egg/schemas/contract.schema.json, they are not the same thing.
Suggested fix:
4. Validates the contract using Pydantic modelsOr if you want to keep the JSON schema reference:
4. Validates the contract against the Pydantic models (which correspond to the JSON schema)This is a minor documentation clarity issue and does not block approval.
Verification
- ✓
action/populate-contract-tasks.pyexists in the codebase - ✓
shared/egg_contracts/plan_parser.pyexists in the codebase - ✓ The script behavior described matches the actual implementation
- ✓ File structure additions are placed correctly in alphabetical/logical order
- ✓ Referenced commit 5f6ccd9 exists and introduces this feature
— Authored by egg
There was a problem hiding this comment.
Review Complete
This documentation PR accurately reflects the contract task population feature introduced in #274.
Verification performed:
- Confirmed
action/populate-contract-tasks.pyexists and matches the documented behavior - Confirmed
shared/egg_contracts/plan_parser.pyexists - Verified the script fetches issue comments, parses
[TASK-X-Y]markers, and writes to the contract JSON - Checked file structure additions are correctly placed
Finding (non-blocking): See my earlier comment about the "JSON schema" wording. The script uses Pydantic model validation, not JSON schema validation. This is a minor documentation clarity issue.
Recommendation: Ready for merge. The documentation accurately describes the feature's purpose and workflow.
— Authored by egg
|
egg review completed. View run logs |
There was a problem hiding this comment.
Review Complete - LGTM ✓
Documentation accurately reflects the contract task population feature introduced in commit 5f6ccd9.
Review notes:
- ✅ Verified
populate-contract-tasks.pyexists on main - ✅ Verified
plan_parser.pyexists in shared/egg_contracts/ - ✅ Documentation correctly describes the workflow (fetch plan → parse → populate → validate)
- ✅ Key Files table appropriately updated with new script references
- ✅ STRUCTURE.md listing matches actual directory structure
— Authored by egg
Update documentation to reflect the new contract task population feature introduced in #274.
Changes
populate-contract-tasks.pyto the action directory listingContext
The
populate-contract-tasks.pyscript was introduced in commit 5f6ccd9 to automate the extraction of tasks from plan documents into contract JSON before the implement phase begins. This bridges the gap between plan approval and implementation by:[TASK-X-Y]markers using the plan parserThis is a significant new component in the SDLC pipeline that was not previously documented.
Triggered by: 5f6ccd9
Authored-by: egg