diff --git a/docs/TASK_TEMPLATE.md b/docs/TASK_TEMPLATE.md index bef782f..8329c4a 100644 --- a/docs/TASK_TEMPLATE.md +++ b/docs/TASK_TEMPLATE.md @@ -1,14 +1,16 @@ # Task Template -Use this structure for Codex implementation tasks. +## Purpose -## Required opening +This document defines the preferred structure for implementation and documentation tasks in this repository. It is intended to keep Codex work small, consistent, and easy to review for both humans and agents. + +## Required Opening - confirm branch strategy -- name the branch to use -- state whether remote update succeeded or local state is being used +- state the branch to use +- say whether local branch state or updated remote state is being used -## Required execution structure +## Required Execution Structure 1. files to change 2. short design explanation @@ -17,9 +19,43 @@ Use this structure for Codex implementation tasks. 5. merge target 6. stop -## Constraints +## Scope Discipline -- no work on main -- no work on develop -- no history rewrite -- no broadening scope without approval \ No newline at end of file +Each task should solve one clear problem. Unrelated cleanup, speculative refactoring, or adjacent changes should not be included unless they were explicitly requested. + +## Branch Discipline + +- do not work directly on `main` +- do not work directly on `develop` +- create task branches from `develop` +- merge task branches back into `develop` + +## Testing and Documentation Expectations + +- tests should be updated when behavior changes +- docs should be updated when behavior changes +- no test should be claimed as passed unless it was actually run + +## Small Examples + +Documentation-only task: +- files to change: `README.md` +- short design explanation: clarify current phase-0 repository purpose +- code/doc/test changes: update documentation only +- commit message: `docs: clarify phase 0 repository purpose` +- merge target: `develop` +- stop + +Code-change task: +- files to change: `scripts/doctor.sh`, `Makefile` +- short design explanation: add one validation check and expose it through `make doctor` +- code/doc/test changes: update script, command entrypoint, and docs if behavior changes +- commit message: `build: extend doctor validation` +- merge target: `develop` +- stop + +## Related Files + +- `AGENTS.md` +- `docs/WORKFLOW.md` +- `docs/MACHINE_SETUP.md`