bisco/hoopscout-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'feature/task-template-doc-phase-0' into develop

Browse Source
This commit is contained in:
bisco
2026-03-20 19:18:51 +01:00
parent 76d99d9ffc d3c58d6166
commit d65a39fa51
1 changed files with 46 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/TASK_TEMPLATE.md
View File

@ -1,14 +1,16 @@
# Task Template # 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 - confirm branch strategy
- name the branch to use - state the branch to use
- state whether remote update succeeded or local state is being used - say whether local branch state or updated remote state is being used
## Required execution structure ## Required Execution Structure
1. files to change 1. files to change
2. short design explanation 2. short design explanation
@ -17,9 +19,43 @@ Use this structure for Codex implementation tasks.
5. merge target 5. merge target
6. stop 6. stop
## Constraints ## Scope Discipline
- no work on main Each task should solve one clear problem. Unrelated cleanup, speculative refactoring, or adjacent changes should not be included unless they were explicitly requested.
- no work on develop
- no history rewrite ## Branch Discipline
- no broadening scope without approval
- 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`