Skip to content

PULL REQUEST TEMPLATE

Summary

-

Changes

-

Type of change

  • New guide
  • Revision to an existing guide
  • New tool / hook / skill / plugin / starter
  • Fix (typo, link, small inaccuracy)
  • CI / tooling change
  • Other

Checklist (style and structure)

  • I read CONTRIBUTING.md and followed the style guide.
  • Headings follow the convention (H1 title, H2 sections, H3 subsections).
  • Code blocks are fenced with a language tag.
  • Internal links are relative (not absolute URLs to this repo).
  • Guides have a ## See Also section with 3–4 cross-links.
  • index.md tables updated if a new file was added.
  • CHANGELOG.md updated under the current unreleased / next-version section.
  • For shell changes: passes shellcheck locally (CI will enforce).
  • For new CLAUDE.md templates: passes bash tools/lint-claude-md.sh.
  • No emojis in guide content (except the ✅ ⚠️ ❌ markers already used in benchmarks).
  • No secrets, API keys, or absolute paths from my laptop in any file.

Test plan

-

Notes for the reviewer