docs: close out phase 0 workflow foundation

This commit is contained in:
bisco
2026-03-20 19:23:30 +01:00
parent d65a39fa51
commit 44aa06a3a8
5 changed files with 18 additions and 8 deletions

View File

@ -17,4 +17,4 @@ When this skill is used:
7. Stop. 7. Stop.
Do not perform release actions. Do not perform release actions.
Do not merge into main. Do not merge into main.

View File

@ -92,6 +92,7 @@ When starting on a new machine:
2. Authenticate Codex locally. 2. Authenticate Codex locally.
3. Checkout the correct branch, typically `develop` or the assigned task branch. 3. Checkout the correct branch, typically `develop` or the assigned task branch.
4. Read `AGENTS.md`, `docs/WORKFLOW.md`, `docs/MACHINE_SETUP.md`, and `docs/TASK_TEMPLATE.md`. 4. Read `AGENTS.md`, `docs/WORKFLOW.md`, `docs/MACHINE_SETUP.md`, and `docs/TASK_TEMPLATE.md`.
5. Run `make doctor` to validate the local repository bootstrap before starting a task.
## Codex Task Style ## Codex Task Style
@ -108,7 +109,7 @@ Codex tasks in this repository should follow this order:
## Local Checks ## Local Checks
Run `make doctor` to perform the repository's local bootstrap and environment checks. Run `make doctor` as part of machine/bootstrap validation to confirm the repository foundation is present and aligned.
## Current Status ## Current Status

View File

@ -37,7 +37,8 @@ Use this sequence on a new machine:
- `docs/WORKFLOW.md` - `docs/WORKFLOW.md`
- `docs/MACHINE_SETUP.md` - `docs/MACHINE_SETUP.md`
- `docs/TASK_TEMPLATE.md` - `docs/TASK_TEMPLATE.md`
5. Create a task branch from `develop`. 5. Run `make doctor`.
6. Create a task branch from `develop`.
## Validation Checklist ## Validation Checklist
@ -48,12 +49,15 @@ A machine is ready for repository work when:
- `AGENTS.md` is present - `AGENTS.md` is present
- `.codex/config.toml` is present - `.codex/config.toml` is present
- `.codex/agents/` is present - `.codex/agents/` is present
- docs are present - `.agents/skills/` is present
- `docs/WORKFLOW.md` is present
- `docs/MACHINE_SETUP.md` is present
- `docs/TASK_TEMPLATE.md` is present
- `make doctor` works - `make doctor` works
## Local Checks ## Local Checks
Run `make doctor` to verify the repository bootstrap and local working assumptions. Run `make doctor` during bootstrap to verify the repository bootstrap and local working assumptions.
## Troubleshooting ## Troubleshooting

View File

@ -80,6 +80,7 @@ Example feature branch flow:
```bash ```bash
git checkout develop git checkout develop
git pull git pull
# if git pull fails, continue using local branch state and say so explicitly
git checkout -b feature/example-task git checkout -b feature/example-task
# make focused changes # make focused changes
git commit -m "docs: describe example task flow" git commit -m "docs: describe example task flow"

View File

@ -6,13 +6,17 @@ echo "== Repo doctor =="
test -f AGENTS.md && echo "AGENTS.md: OK" || { echo "AGENTS.md: MISSING"; exit 1; } test -f AGENTS.md && echo "AGENTS.md: OK" || { echo "AGENTS.md: MISSING"; exit 1; }
test -f .codex/config.toml && echo ".codex/config.toml: OK" || { echo ".codex/config.toml: MISSING"; exit 1; } test -f .codex/config.toml && echo ".codex/config.toml: OK" || { echo ".codex/config.toml: MISSING"; exit 1; }
test -d .codex/agents && echo ".codex/agents: OK" || { echo ".codex/agents: MISSING"; exit 1; } test -d .codex/agents && echo ".codex/agents: OK" || { echo ".codex/agents: MISSING"; exit 1; }
test -d docs && echo "docs/: OK" || { echo "docs/: MISSING"; exit 1; } test -d .agents/skills && echo ".agents/skills: OK" || { echo ".agents/skills: MISSING"; exit 1; }
test -f .agents/skills/task-closeout/SKILL.md && echo ".agents/skills/task-closeout/SKILL.md: OK" || { echo ".agents/skills/task-closeout/SKILL.md: MISSING"; exit 1; }
test -f docs/WORKFLOW.md && echo "docs/WORKFLOW.md: OK" || { echo "docs/WORKFLOW.md: MISSING"; exit 1; }
test -f docs/MACHINE_SETUP.md && echo "docs/MACHINE_SETUP.md: OK" || { echo "docs/MACHINE_SETUP.md: MISSING"; exit 1; }
test -f docs/TASK_TEMPLATE.md && echo "docs/TASK_TEMPLATE.md: OK" || { echo "docs/TASK_TEMPLATE.md: MISSING"; exit 1; }
branch="$(git rev-parse --abbrev-ref HEAD)" branch="$(git rev-parse --abbrev-ref HEAD)"
echo "Current branch: ${branch}" echo "Current branch: ${branch}"
if [[ "${branch}" == "main" || "${branch}" == "develop" ]]; then if [[ "${branch}" == "main" || "${branch}" == "develop" ]]; then
echo "Warning: create a task branch before making changes." echo "Warning: do not make changes on ${branch}; create a task branch from develop first."
fi fi
echo "Doctor completed." echo "Doctor completed."