Skip to content

docs: fix false 'no test harness' claim and add missing Publishing section#102

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-contributing-testing-section-and-publishing-link-402cc131b184210a
Draft

docs: fix false 'no test harness' claim and add missing Publishing section#102
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-contributing-testing-section-and-publishing-link-402cc131b184210a

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 7, 2026

What changed

CONTRIBUTING.md — Testing section rewritten

The previous text stated:

There is no automated test harness for skills — they are instruction sets interpreted by Claude Code, not code with unit tests.

This is factually wrong. The repo ships a three-tier test suite under tests/ (run-tests.sh, test-invariants.sh, three tier-1 skill tests, and tier-3 E2E scripts). The false statement would mislead contributors into skipping the test suite entirely.

The replacement section describes:

  • The ./tests/run-tests.sh entry point and common flags
  • All three tiers (invariants / skill / E2E) with speed expectations
  • Which tiers CI runs automatically vs. which are manual-only
  • Quick validation steps (plugin load, gh aw validate, OAuth grep counts) preserved from the original

README.md — Publishing section added

CONTRIBUTING.md ends with:

See the Publishing section of the README for the steps to submit the plugin to the Claude plugin registry.

That anchor (#publishing) did not exist in README.md, making it a broken cross-reference. The new section documents the four maintainer steps: version bump, tagging/release, the self-hosted marketplace approach, and directory listing updates.

Why no other files changed

The catalog agent files, skill files, and lock files are correct as-is. The fix(agent-team): fail loud on missing dispatch inputs behavior introduced in the parent PR (#69) is already documented in catalog/agent-team/README.md (Limits and gotchas → "Input propagation") and in each agent's "Required input contract" section.

Testing

  • Verified grep -n "no automated" in CONTRIBUTING.md no longer matches
  • Verified grep -n "Publishing" in README.md returns the new section header
  • No lock files changed; gh aw validate not needed

Generated by Update Docs ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/update-docs.md@96b9d4c39aa22359c0b38265927eadb31dcf4e2a

…ction

CONTRIBUTING.md stated 'There is no automated test harness for skills'
which directly contradicts the three-tier test suite in tests/. Replace
that paragraph with an accurate description of tiers 1–3, the run-tests.sh
entry point, and CI coverage.

README.md was missing the Publishing section that CONTRIBUTING.md
references ('See the Publishing section of the README'). Add a minimal
maintainer-focused section covering version bumps, tagging, and the
self-hosted marketplace approach.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels May 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants