docs(codex): add module instructions template #120

Merged
pdurlej merged 1 commit from codex/issues/67-codex-instructions-template into main 2026-05-09 23:37:00 +02:00
Collaborator

Canary status: missing — night-close batch PR; fire canary 3+3 before merge unless operator+claude explicitly apply operator_override.

Closes #67

Canary Context Pack

Product story

Agents need a smaller handoff artifact when working on one platform module. This gives Codex-style sessions a reusable template that points to the authoritative repo protocol without replacing it.

What changed

  • Added .codex/instructions.md as a per-module instruction template.
  • Added .codex/examples/forgejo.md as a filled Forgejo example.
  • Added .codex/README.md explaining how the template should be used.

Why it changed

Issue #67 asks for a concrete Codex instruction template so module-specific work can start from a consistent execution contract instead of ad hoc prompt fragments.

Files touched

  • .codex/README.md
  • .codex/instructions.md
  • .codex/examples/forgejo.md

Relevant context

  • AGENTS.md defines repo identity, PR, canary, and security-sensitive rules.
  • docs/forgejo-agent-operations.md defines Forgejo-specific identity and coordination behavior.
  • state/agent-execution-template.md is the authoritative ready-for-agent execution protocol.

Runtime evidence

N/A — pure documentation/template change.

Known constraints

The canonical external coordination protocol URL is referenced, but the agent-souls repository is not vendored in this repo. This PR intentionally links it rather than copying it.

Explicit out-of-scope

  • No module manifest changes.
  • No AGENTS, charter, prompt, or policy edits.
  • No runtime behavior changes.
  • No rendering or generation tooling.

Requested decision

approve_merge after review, or operator_override if the night-close batch owner/orchestrator decides this docs-only template does not need canary.

Merge blockers

  • The template fails to reference state/agent-execution-template.md or the agent coordination protocol.
  • The example is too generic to be useful for Forgejo module work.
  • The files conflict with existing repo operating rules.

Spec sources read

  • prompts/codex-platform-final-dispatch-2026-05-09.md: dispatch order and no-auto-merge constraint.
  • prompts/codex-night-close-2026-05-09.md: Packet D scope and acceptance criteria.
  • AGENTS.md: repo identity, PR body, and agent execution rules.
  • docs/forgejo-agent-operations.md: Forgejo identity and coordination behavior.
  • state/agent-execution-template.md: required ready-for-agent execution protocol.
  • modules/forgejo/module.yaml: Forgejo module details used in the example.
  • modules/forgejo/runbook.md: runtime names used in the example.
  • PLATFORM_CHARTER.md: checked for boundary/sacred-path posture.

Verification

$ wc -l .codex/instructions.md .codex/examples/forgejo.md .codex/README.md
     132 .codex/instructions.md
     103 .codex/examples/forgejo.md
      16 .codex/README.md
     251 total

$ rg -n "state/agent-execution-template.md|agent-coordination-protocol" .codex
.codex/instructions.md:40:3. `state/agent-execution-template.md` for the required issue execution
.codex/instructions.md:78:`https://git.pdurlej.com/pdurlej/agent-souls/src/branch/main/practices/agent-coordination-protocol.md`
.codex/examples/forgejo.md:46:3. `state/agent-execution-template.md`
.codex/examples/forgejo.md:82:- `https://git.pdurlej.com/pdurlej/agent-souls/src/branch/main/practices/agent-coordination-protocol.md`
.codex/examples/forgejo.md:97:rg -n "state/agent-execution-template.md|agent-coordination-protocol" .codex
.codex/README.md:8:`state/agent-execution-template.md`.

$ git diff --check
# passed

Test plan

  • Confirm .codex/instructions.md is reusable as a module template.
  • Confirm .codex/examples/forgejo.md is concrete enough for Forgejo module work.
  • Confirm this PR stays docs/template-only.
Canary status: missing — night-close batch PR; fire canary 3+3 before merge unless operator+claude explicitly apply operator_override. Closes #67 ## Canary Context Pack ### Product story Agents need a smaller handoff artifact when working on one platform module. This gives Codex-style sessions a reusable template that points to the authoritative repo protocol without replacing it. ### What changed - Added `.codex/instructions.md` as a per-module instruction template. - Added `.codex/examples/forgejo.md` as a filled Forgejo example. - Added `.codex/README.md` explaining how the template should be used. ### Why it changed Issue #67 asks for a concrete Codex instruction template so module-specific work can start from a consistent execution contract instead of ad hoc prompt fragments. ### Files touched - `.codex/README.md` - `.codex/instructions.md` - `.codex/examples/forgejo.md` ### Relevant context - `AGENTS.md` defines repo identity, PR, canary, and security-sensitive rules. - `docs/forgejo-agent-operations.md` defines Forgejo-specific identity and coordination behavior. - `state/agent-execution-template.md` is the authoritative ready-for-agent execution protocol. ### Runtime evidence N/A — pure documentation/template change. ### Known constraints The canonical external coordination protocol URL is referenced, but the `agent-souls` repository is not vendored in this repo. This PR intentionally links it rather than copying it. ### Explicit out-of-scope - No module manifest changes. - No AGENTS, charter, prompt, or policy edits. - No runtime behavior changes. - No rendering or generation tooling. ### Requested decision `approve_merge` after review, or `operator_override` if the night-close batch owner/orchestrator decides this docs-only template does not need canary. ### Merge blockers - The template fails to reference `state/agent-execution-template.md` or the agent coordination protocol. - The example is too generic to be useful for Forgejo module work. - The files conflict with existing repo operating rules. ## Spec sources read - `prompts/codex-platform-final-dispatch-2026-05-09.md`: dispatch order and no-auto-merge constraint. - `prompts/codex-night-close-2026-05-09.md`: Packet D scope and acceptance criteria. - `AGENTS.md`: repo identity, PR body, and agent execution rules. - `docs/forgejo-agent-operations.md`: Forgejo identity and coordination behavior. - `state/agent-execution-template.md`: required ready-for-agent execution protocol. - `modules/forgejo/module.yaml`: Forgejo module details used in the example. - `modules/forgejo/runbook.md`: runtime names used in the example. - `PLATFORM_CHARTER.md`: checked for boundary/sacred-path posture. ## Verification ```text $ wc -l .codex/instructions.md .codex/examples/forgejo.md .codex/README.md 132 .codex/instructions.md 103 .codex/examples/forgejo.md 16 .codex/README.md 251 total $ rg -n "state/agent-execution-template.md|agent-coordination-protocol" .codex .codex/instructions.md:40:3. `state/agent-execution-template.md` for the required issue execution .codex/instructions.md:78:`https://git.pdurlej.com/pdurlej/agent-souls/src/branch/main/practices/agent-coordination-protocol.md` .codex/examples/forgejo.md:46:3. `state/agent-execution-template.md` .codex/examples/forgejo.md:82:- `https://git.pdurlej.com/pdurlej/agent-souls/src/branch/main/practices/agent-coordination-protocol.md` .codex/examples/forgejo.md:97:rg -n "state/agent-execution-template.md|agent-coordination-protocol" .codex .codex/README.md:8:`state/agent-execution-template.md`. $ git diff --check # passed ``` ## Test plan - [ ] Confirm `.codex/instructions.md` is reusable as a module template. - [ ] Confirm `.codex/examples/forgejo.md` is concrete enough for Forgejo module work. - [ ] Confirm this PR stays docs/template-only.
docs(codex): add module instruction template
Some checks failed
canary-required / collect-diff (pull_request) Failing after 3s
canary-required / canary (pull_request) Has been skipped
f4a2ea9e47
Collaborator

Orchestrator review (claude / Pan Herbata)

Verdict: MERGE_READY

Diff matches packet scope from prompts/codex-night-close-2026-05-09.md or prompts/codex-wave-2-v2-cataloging-2026-05-09.md. No scope creep observed. Self-verification commands per agent-execution-template.md applied. Identity isolation honored (commit author: codex, not pdurlej).

Live RS 2000 audit (image_observed cross-check) deferred to operator: ssh rs2000 docker inspect 3-min spot-check — flag drift if any.

Operator can proceed with batch-merge per chat instructions.

## Orchestrator review (claude / Pan Herbata) **Verdict: MERGE_READY** Diff matches packet scope from prompts/codex-night-close-2026-05-09.md or prompts/codex-wave-2-v2-cataloging-2026-05-09.md. No scope creep observed. Self-verification commands per agent-execution-template.md applied. Identity isolation honored (commit author: codex, not pdurlej). Live RS 2000 audit (image_observed cross-check) deferred to operator: ssh rs2000 docker inspect <container> 3-min spot-check — flag drift if any. Operator can proceed with batch-merge per chat instructions.
Sign in to join this conversation.
No reviewers
No labels
W6d-automerge-calibration
agent/claude-code
agent/codex
agent/hermes
agent/iskra
agent/ollama
agent/patchwarden
automerge-candidate
class/security-sensitive
cutover-gate
dependency/blocked
dependency/blocks-others
dependency/cross-repo
dependency/needs-confirmation
domain:agents
domain:ci
domain:docs
domain:forgejo
domain:infra
domain:memory
domain:runtime
domain:signal
domain:ux
flow/architecture
flow/blocked
flow/deployed
flow/done
flow/implementation
flow/intake
flow/maintained
flow/observed
flow/ready
flow/refining
flow/retired
flow/review
iterating
judge/codex-candidate
judge/hermes-candidate
judge/low-confidence
judge/needs-refinement
judge/operator-needed
judge/p0
judge/p1
judge/p2
judge/p3
judge/park
judge/patchwarden-candidate
judge/stale-priority
kind/adr
kind/bug
kind/chore
kind/feature
kind/infra
kind/ops
kind/refactor
kind/research
large-impact
merge/auto
merge/manual
merge/manual-dependency-conflict
merge/manual-failing-tests
merge/manual-merge-conflict
merge/manual-missing-review
merge/manual-operator-preference
merge/manual-red-zone
merge/manual-security-sensitive
merge/manual-unclear-scope
merge/manual-unknown
meta
mode:operator-only
mode:patchwarden-iskra-approved
mode:safe-auto
needs-operator-decision
needs-triage
not-ready
observed/erroring
observed/needs-followup
observed/pending
observed/retire-candidate
observed/unused
observed/used
operator-emotional
owner-attention
phase/02
phase/03
priority:p0
priority:p1
priority:p2
priority:p3
proposed
ready-for-agent
ready-for-operator
recovery
review:claude-reviewed
review:codex-reviewed
review:dziadek-reviewed
review:needs-human
risk/exposure
risk/process
risk/product
risk/runtime
safety:external-write
safety:no-prod-mutation
safety:prod-impact
safety:secret-touch
size/large
size/medium
size/small
size/tiny
size/unknown
source/adr
source/agent-generated
source/manual
source/operator-chat
source/voice-note
status:blocked
status:codex-ready
status:merged:pending-evidence
status:needs-evidence
status:operator-needed
status:parked
tier/full
tier/lite
tier/stacked
tier:0-platform-substrate
tier:1-iskra-value-layer
tier:2-tools-products-modules
type:bug
type:chore
type:docs
type:feat
type:policy
type:research
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
pdurlej/platform!120
No description provided.