Skip to content

docs: describe back-to-back ack.sh calls in the README - #228

Open
tupe12334 wants to merge 1 commit into
mainfrom
fix/issue-225-readme-ack-order
Open

tupe12334 wants to merge 1 commit into
mainfrom
fix/issue-225-readme-ack-order

Conversation

@tupe12334

Copy link
Copy Markdown
Member

Closes #225

What

README line 52 claimed "Each checklist item requires one full hook invocation to acknowledge. The agent cannot skip ahead." Since #223 (shipped in 0.2.1), ack.sh sets the next state's transitions itself, so it can be run back to back without retrying the gated action — the claim is no longer accurate.

This PR takes option 1 from the issue (keep #223's deliberate behavior, fix the docs). The sentence now states the real guarantee:

  • items are acknowledged in flow order, one state per ack.sh call;
  • ack.sh may run several times in a row, so the hook doesn't guarantee each question was shown first;
  • every ack lands in the audit log.

If you'd rather restore one-question-per-invocation (option 2 — a shown marker enforced by ack.sh), close this and I'll leave it for a code change. @tupe12334

Checks

Docs-only (1 line in README.md). git diff --check clean, linecheck . passes (warnings only, pre-existing). No Rust changes, so fmt/clippy/test are unaffected.


This pull request was opened by the moadim routine "Open issues → fix PRs (owned repos + my orgs)".

🤖 Generated with Claude Code

Since #223 (0.2.1) ack.sh can advance several states without the hook
firing in between, so the README claim that the agent cannot skip ahead
is no longer true. Document the actual guarantee: in-order, one state
per ack, every ack audited.

Closes #225

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README says agent cannot skip ahead, but since #223 back-to-back ack.sh calls ack never-shown items (0.2.1)

1 participant