Skip to content

chore(docs): update AGENTS.md to reflect recent changes - #241

Open
RedStar071 wants to merge 1 commit into
mainfrom
claude/zen-goodall-7856hx
Open

RedStar071 wants to merge 1 commit into
mainfrom
claude/zen-goodall-7856hx

Conversation

@RedStar071

@RedStar071 RedStar071 commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

🔗 Linked issue

N/A — found while running the weekly "Maintain AGENTS.md" routine.

🧭 Context

Reviewed the pull requests merged into main in the last 7 days (Oct 4–9) and the source/config files they touched, to check whether AGENTS.md still documents the repo's actual conventions. Most recent docs/convention PRs (#199, #200, #204, #205, #211–#215) already keep AGENTS.md current. Two gaps were still missing though:

  1. knip (the unused-code/dependency checker) has been a devDependency and CI job (🧹 Unused code check) since the repo's first commit, and feat(plugin-logger): rework the sentry, evlog and winston transports #232 touched knip.json again (adding a plugin-logger entry point) — but it was never mentioned anywhere in AGENTS.md.
  2. Recent structural-change PRs (feat(plugin-gateway)!: match discord.js bulkDelete and Message typings #206 bulkDelete/Message parity, feat(plugin-gateway)!: align equals() with discord.js across structures #218 equals() parity, and earlier parity work going back to late September) consistently write a design plan/spec under docs/superpowers/plans/ and docs/superpowers/specs/ and link it from the PR description instead of re-explaining the design — an established, repo-wide pattern with 8+ plans and 14+ specs, but likewise undocumented.

📚 Description

  • Added knip to the Stack list, the quality gates list, and the Commands block, noting it has no root package.json script (pnpm exec knip directly) and pointing at knip.json for per-workspace overrides.
  • Added a Conventions bullet documenting the docs/superpowers/plans/ + docs/superpowers/specs/ design-doc pattern for non-trivial structural work, with the naming convention and an example.
  • Updated the "Done means" line to stop hardcoding "the four quality gates" now that there are five.

No other gaps found: package descriptions, engines ranges (plugin-api still >=20.18.1 after the undici v8 bump in #181), the typecheck script's consumption-test list, and the PR/commit conventions sections all still match the current code.

Key changes

Area Before After
Stack / Quality gates / Commands No mention of knip Documents knip as a stack tool, 5th quality gate, and pnpm exec knip command
Conventions No mention of design docs Documents the docs/superpowers/{plans,specs}/ convention

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation change
  • Workflow / CI change

Pre-flight Checklist

  • I have read the Contributing Guidelines (if applicable)
  • My code follows the code style of this project
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the documentation accordingly
  • I added a changeset with pnpm changeset (or pnpm changeset add --empty if no release is needed). See .changeset/README.md.

🤖 AI disclosure: Claude Code was used on this PR. Code written with claude-sonnet-5; PR description written with claude-sonnet-5. AI policy.


Generated by Claude Code

Review of PRs merged in the last 7 days surfaced two established
conventions missing from AGENTS.md: the knip unused-code/dependency
check (devDependency and CI job since the repo's first commit, touched
again in #232) has no root script and was undocumented, and recent
structural-change PRs (#206, #218, and earlier parity work) consistently
link a plan/spec under docs/superpowers/ that AGENTS.md never mentioned.
@coldtea-pr-lens

Copy link
Copy Markdown

Note

The title starts with chore(docs):, so PR Lens left this pull request undrawn. Comment @pr-lens draw to draw it

github.comment.notice: false in .github/pr-lens.yml turns this note off

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ No critical issues — the doc changes are accurate; one PR body rule violation and one optional consistency note.

Reviewed changes

Reviewed the single-commit docs change to AGENTS.md, checking each new claim against knip.json, .github/workflows/ci.yml, root package.json and docs/superpowers/.

  • knip documented — added to Stack, the quality gates (as gate 5) and the Commands block. Verified: knip is a root devDependency, there is no root script, CI job 🧹 Unused code check runs pnpm exec knip, and knip.json has the packages/plugin-logger src/assertions.ts entry.
  • Design-doc convention — new Conventions bullet for docs/superpowers/plans/ and docs/superpowers/specs/. Verified: the naming patterns match the existing files, and the example 2026-10-05-message-types-parity-design.md exists.
  • "Done means" wording — "the four quality gates" became "the quality gates", so it no longer goes stale. No other "four gates" text remains in the repo.

ℹ️ PR body carries a second attribution footer

The PR body ends with _Generated by [Claude Code](https://claude.ai/code)_ after the disclosure line. AGENTS.md says the disclosure line is the only AI attribution a PR body may carry and that nothing may follow it, so the footer and the --- rule above it should be removed.

Technical details
# Remove trailing attribution from the PR body

## Affected sites
- PR #241 body — ends with `---` and `_Generated by [Claude Code](https://claude.ai/code)_` after the `🤖 AI disclosure:` line.

## Required outcome
- The body has exactly one disclosure line and nothing after it (see the "AI disclosure" bullet in `AGENTS.md` Conventions).

ℹ️ implement-issue skill's gate chain omits knip

.claude/skills/implement-issue/SKILL.md:74 still lists pnpm lint && pnpm build && pnpm typecheck && pnpm test, while AGENTS.md now lists knip as the fifth gate, so an agent following that skill won't run it. The skill is shared with stars-components, so this is optional and may be better as a follow-up.

Pullfrog  | Fix it ➔ | View workflow run | Using claude-sonnet-5-5 | 𝕏

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.

2 participants