docs: document agent-team contracts and automated test suite (post-d688265)#132
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
…88265 - CONTRIBUTING.md: add "Adding or modifying an agent-team workflow role" section covering the required-input-contract, iteration-guard, and optional-input patterns established by d688265. Contributors adding new agent roles now have explicit guidance without having to read the diff. - CONTRIBUTING.md: replace "no automated test harness" with a two-tier description (tier-2 invariants = fast + CI-enforced; tier-1/3 = Claude auth required). Add step 1 "run ./tests/test-invariants.sh" and a note on updating the invariant file when adding/removing pinned phrases. - tests/test-invariants.sh: split the three d688265 invariants into their own section header so every assertion traces to the correct commit SHA, matching the traceability guarantee described in tests/README.md. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions
Bot
added
automation
documentation
This was referenced May 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed and why
Commit
d688265established two mandatory patterns for allworkflow_dispatchagent roles — the required-input-contract and the iteration guard — and added three tier-2 invariants to enforce them.CONTRIBUTING.mdandtests/test-invariants.shwere not updated in that commit, leaving three documentation gaps:1. No guidance for catalog contributors (
CONTRIBUTING.md)Added a new "Adding or modifying an agent-team workflow role" section under "What to contribute". It documents:
state:blockedand stop on excess)pr_numbercanonical example)planner-agent.md,implementer-agent.md)Without this, a contributor adding a fifth agent role would have to diff
d688265to discover the pattern.2. Outdated testing section (
CONTRIBUTING.md)The old section opened with "There is no automated test harness for skills", which was misleading: CI runs tier-2 invariants and three tier-1 skill tests on every PR. Updated to:
./tests/test-invariants.sh(before loading the plugin)test-invariants.shwhen adding/removing pinned phrases3. Traceability broken in
tests/test-invariants.shThe three new invariants from
d688265were appended inside thec99b00fgroup, violating the "each invariant carries a commit-sha comment" guarantee thattests/README.mddescribes. Moved them into their ownd688265section with an inline explanation comment.Testing
./tests/test-invariants.sh— all 27 assertions pass ✅