Skip to content

docs: fix stale Testing section and broken Publishing link in CONTRIBUTING#66

Draft
github-actions[bot] wants to merge 1 commit intomainfrom
docs/fix-contributing-testing-and-publishing-4cffc1df0dd61b8f
Draft

docs: fix stale Testing section and broken Publishing link in CONTRIBUTING#66
github-actions[bot] wants to merge 1 commit intomainfrom
docs/fix-contributing-testing-and-publishing-4cffc1df0dd61b8f

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Two documentation gaps found during an update-docs pass on CONTRIBUTING.md.

What changed

Testing section (lines 75–99)

The previous text opened with "There is no automated test harness for skills" — accurate when the file was first written, but the repo now ships a full three-tier test suite (tests/run-tests.sh) that CI executes on every PR.

Replaced with:

  • The actual run commands (./tests/run-tests.sh, --verbose flag)
  • A tier table (invariants / skills / E2E) with speed expectations matching tests/README.md
  • A note that CI runs tiers 2 + 1 automatically
  • Preserved the lock-file validation and grep-count reminders for OAuth-tweak changes
  • A link to tests/README.md for full details

Publishing section (lines 128–136)

The previous text was a single sentence: "See the Publishing section of the README for the steps..." — but README.md has no ## Publishing section, making this a broken cross-reference.

Replaced with self-contained steps:

  1. Version bump in .claude-plugin/plugin.json
  2. GitHub Release tagged v<version> (marketplace JSON references main, so installations auto-update)
  3. Registry updates on claude-plugins.dev and ClaudePluginHub

Why no other files changed

README.md and tests/README.md are accurate. The skill files (SKILL.md) are intentionally stable instruction sets; their "Out of scope" lists describe what the skill doesn't do, which is still correct. No other doc drift was found.

Testing

No code changes — documentation only. Verify by reading the rendered Markdown on this PR.

Generated by Update Docs ·

To install this agentic workflow, run

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

…UTING

Two gaps surfaced by an update-docs pass:

- Testing section said "There is no automated test harness for skills"
  but the repo ships a three-tier suite (tests/run-tests.sh) that CI
  runs on every PR. Replaced with the actual run commands, tier table,
  and a link to tests/README.md for full details.

- Publishing section linked to README.md#publishing, an anchor that
  doesn't exist in the README. Replaced the dead link with self-contained
  steps: version bump in plugin.json, GitHub Release, and registry
  updates on claude-plugins.dev and ClaudePluginHub.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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