Skip to content

docs: Document contract task population [doc-updater] #275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwbron merged 1 commit into from
Feb 8, 2026
Merged

docs: Document contract task population [doc-updater] #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions action/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ This action runs the egg autonomous coding agent within GitHub Actions. It sets
| `build-sdlc-prompt.sh` | Builds phase-specific prompts for SDLC pipeline workflows |
| `contract-state.sh` | Contract state management utility for SDLC pipeline |
| `escalate.sh` | SDLC pipeline escalation handler (circuit breaker triggers HITL intervention) |
| `populate-contract-tasks.py` | Populates contract tasks from plan document (runs before implement phase) |
| `generate-config.sh` | Generates runtime configuration from action inputs |

## Quick Start
Expand Down
1 change: 1 addition & 0 deletions docs/development/STRUCTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ action/
├── build-sdlc-prompt.sh # SDLC pipeline prompt builder
├── contract-state.sh # Contract state management utility
├── escalate.sh # SDLC pipeline escalation handler
├── populate-contract-tasks.py # Populates contract tasks from plan document
├── autofixer-conventions.md # Guidelines for autofixer behavior
├── review-conventions.md # Guidelines for review communication
└── README.md
Expand Down
14 changes: 14 additions & 0 deletions docs/guides/sdlc-pipeline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,18 @@ Template sections:
- [TASK-1-2] Add role validation — Acceptance: Unauthorized mutations rejected
```

### Task Population

After the plan is approved, tasks are automatically extracted from the plan document and populated into the contract before the implement phase begins.

The `action/populate-contract-tasks.py` script:
1. Fetches the plan comment from the GitHub issue
2. Parses task markers using `shared/egg_contracts/plan_parser.py`
3. Writes phases and tasks into `.egg-state/contracts/{issue-number}.json`
4. Validates the contract against the JSON schema

This ensures the implementer starts with a fully populated contract containing all planned tasks and acceptance criteria.

## Implementation Reference

### Key Files
Expand All @@ -341,7 +353,9 @@ Template sections:
|------|---------|
| `.github/workflows/sdlc-pipeline.yml` | Main pipeline orchestration |
| `.github/workflows/sdlc-hitl.yml` | HITL checkbox detection |
| `action/populate-contract-tasks.py` | Extracts tasks from plan into contract |
| `shared/egg_contracts/models.py` | Pydantic models for contract |
| `shared/egg_contracts/plan_parser.py` | Parses plan documents for task extraction |
| `shared/egg_contracts/roles.py` | Role definitions and field ownership |
| `shared/egg_contracts/validator.py` | Mutation validation |
| `shared/egg_contracts/circuit_breaker.py` | Escalation logic |
Expand Down
Loading