Skip to content

Require complete phase-aware onboarding before agents claim workflow compliance #25

Description

@yuema137

Request

Make complete, phase-appropriate onboarding a structural prerequisite for a new session or agent using Structured Coding, rather than relying only on the agent remembering to follow links. Put an unmistakable agent entrypoint in the README and copyable kickoff instructions, and provide a checkable required-resource handoff. Where the host permits enforcement, refuse dependent implementation actions until that prerequisite is satisfied; distinguish this from advisory documentation on other hosts.

This is an onboarding/reliability enhancement motivated by an actual agent failure, not a claim that the existing single-PR rule is ambiguous.

Observed incident (v0.1.2)

  1. A planning session maintained one combined step/PR design for a step containing one PR.
  2. In a later continuation, the agent consulted the three detailed prompt documents but did not recheck the entrypoint and detailed workflow before answering a question about document ownership.
  3. When the operator asked why there was no separate PR design, the agent incorrectly said the combined document violated Structured Coding and proposed splitting it.
  4. Only after the operator challenged that answer did the agent read the relevant entrypoint/workflow text and retract its recommendation.

No source change or runtime failure is claimed here. The observed failure was an unsupported compliance judgement and proposed unnecessary document restructuring. The agent remains responsible for the omission; the request is to make this failure harder to repeat across new/replacement sessions and delegated agents.

The existing rule is explicit

  • v0.1.2 SKILL.md, Essential operating rules 2: a one-PR step is expanded in place into its PR design.
  • v0.1.2 agent-workflow.md, section 3: label the combined role and do not maintain duplicate plans.
  • The entrypoint requires reading agent-workflow.md and adaptation.md, then the complete phase-specific resources.
  • Source and Codex-distribution copies of both SKILL.md and agent-workflow.md were checked at v0.1.2 and have identical Git blobs. This was not a packaging omission.

The human README's copyable execution prompt prominently names the two execution prompts. It also says to use the skill, so it is not an instruction to skip the entrypoint. Nevertheless, a session can follow the prominent prompt links selectively and report compliance without exposing which required routing material it missed. Current documentation also honestly distinguishes hook reminders from proof of recovery; that limitation should be preserved, not papered over.

Desired behavior

  1. One visible bootstrap route. The root README, installed-package README and kickoff examples direct new/replacement sessions to the actual installed or pinned SKILL.md first. Keep generated human docs synchronized through their source, rather than editing generated README files alone.
  2. One phase-aware required-resource list. Resolve the workflow/adaptation resources, phase-specific full prompts, and applicable project rules/design/contract from the selected version. Do not make agents infer the required set from a few copied prompt names, and do not load every optional resource for unrelated small work.
  3. An explicit onboarding state before dependent work. Record resource identities/version and whether their full contents were made available to this session. Missing, truncated, stale or unresolved resources are not READY. An absent installed skill must produce an explicit recovery path (install/invoke it, or use a clearly identified pinned manual entrypoint), not silent partial adoption.
  4. Do not infer compliance from an acknowledgement. A checkbox, file hash, or helper process reading a file cannot prove that the model received or understood it. State exactly what a receipt or host integration establishes. Report unsupported enforcement honestly.
  5. Preserve workflow boundaries. A missing onboarding prerequisite may block implementation, but must still allow read-only inspection and repair of the onboarding/design state. Do not introduce per-commit operator approvals, implicit hook installation, merge authority, or a rule that forces the full workflow onto small unrelated edits.

The desired outcome is stronger than another reminder buried in prose. The precise mechanism is for maintainers to choose; documentation-only improvements should not be described as mechanical enforcement.

Acceptance / regression cases

  • A session starting from the README's copyable kickoff is routed through the entrypoint and receives the full mandatory resource list for its phase.
  • Supplying only the three long prompts cannot yield a complete-onboarding verdict when workflow/adaptation resources are still missing.
  • Missing files, truncated/paginated reads, and incompatible resource versions are surfaced rather than silently treated as complete; after repair, the session can proceed without a new approval for the same already-authorized scope.
  • Single-PR and multi-PR examples preserve their distinct document rules; a recovery/continuation test includes this incident's one-PR combined-document case.
  • Source and distributed packages stay consistent, and any host-level blocking claim has a corresponding integration test. Content tests alone are not reported as proof of agent adherence.
  • New/replacement/delegated-agent onboarding and compact/resume recovery have explicit rules for what must be reloaded. Do not create repeated whole-library reading on every ordinary turn.

Scope

Please address bootstrap/read-completeness and its documented enforcement limits. No change is requested to the already-correct single-PR document rule, implementation permissions, or merge policy.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions