Task Template

Purpose

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
state the branch to use
say whether local branch state or updated remote state is being used

Required Execution Structure

files to change
short design explanation
code/doc/test changes
commit message
merge target
stop

Scope Discipline

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

AGENTS.md
docs/WORKFLOW.md
docs/MACHINE_SETUP.md

1.8 KiB Raw Blame History