67 lines
1.2 KiB
Markdown
67 lines
1.2 KiB
Markdown
# Build Pass Template
|
|
|
|
Use this exact structure for every Codex build pass.
|
|
|
|
## Pass Name
|
|
Example: `Pass 03 — Dataset Manager Backend`
|
|
|
|
## Goal
|
|
One sentence describing the feature outcome.
|
|
|
|
## Inputs
|
|
- Required docs:
|
|
- Required contracts:
|
|
- Required fixtures:
|
|
- Previous pass dependencies:
|
|
|
|
## Scope
|
|
### Must implement
|
|
- [ ] Item
|
|
|
|
### May improve
|
|
- [ ] Item
|
|
|
|
### Must not touch
|
|
- [ ] Item
|
|
|
|
## Implementation Steps
|
|
1. Inspect existing repo state.
|
|
2. Confirm relevant contracts.
|
|
3. Implement backend/domain changes.
|
|
4. Implement frontend/API client changes if applicable.
|
|
5. Add or update tests.
|
|
6. Add fixtures if needed.
|
|
7. Update docs and TODO status.
|
|
8. Run validation commands.
|
|
9. Produce pass summary.
|
|
|
|
## Validation Commands
|
|
```bash
|
|
# backend
|
|
pytest
|
|
ruff check backend || true
|
|
|
|
# frontend
|
|
npm run build
|
|
npm run typecheck || true
|
|
npm run lint || true
|
|
```
|
|
|
|
## Acceptance Criteria
|
|
- [ ] Feature works through API or UI.
|
|
- [ ] Errors are explicit and typed.
|
|
- [ ] No mock success path is presented as real.
|
|
- [ ] Tests or fixtures cover the happy path and at least one failure path.
|
|
- [ ] Documentation is updated.
|
|
|
|
## Handoff Format
|
|
```md
|
|
# Pass Summary
|
|
## Completed
|
|
## Changed Files
|
|
## Commands Run
|
|
## Test Results
|
|
## Known Issues
|
|
## Next Step
|
|
```
|