chore: add issue forms and PR template#19
Conversation
structured bug/feature/api-regression issue forms and a PR template that forces the info needed to actually review a change: version, repro, how-to-verify steps, and a sparkle/release checklist guarding the auto-update bricking rules in CLAUDE.md.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis PR introduces GitHub templates to standardize issue reporting and pull request submissions. Five new template files are added: a configuration file that disables blank issues and routes questions/security reports, three issue templates for bugs, API regressions, and feature requests with guided forms, and a PR template enforcing Conventional Commits conventions with required narrative and release verification sections. ChangesGitHub Templates Configuration
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@claude review |
|
Claude finished @ericjypark's task in 1m 29s —— View job PR Review
This is a solid, well-considered set of templates. A few observations: What's working well
Minor issues
Verdict: Ready to merge. Item 1 (Discussions) is the only thing worth double-checking before the templates go live — everything else is stylistic. |
|
Self-review pass on the diff. Things worth flagging before merge: Pre-flight caveats
Things I deliberately did not include
Risk Metadata only. Worst case: a typo in a template, fixable in one commit. Nothing here can affect Sparkle, the build, or auto-update. Recommend merging once Discussions + private security reporting are confirmed enabled. Generated by Claude Code |
What changed
Adds structured GitHub templates so incoming bugs and PRs arrive with the info needed to triage and review them.
.github/ISSUE_TEMPLATE/bug_report.yml— required fields for app version, macOS version, install method, repro steps, area dropdown, plus optional settings/log dumps..github/ISSUE_TEMPLATE/feature_request.yml— problem-first framing, alternatives, scope estimate..github/ISSUE_TEMPLATE/api_regression.yml— dedicated form for the undocumented Claude/Codex usage endpoints; asks for the raw response (token redacted) so the parser can be updated quickly..github/ISSUE_TEMPLATE/config.yml— disables blank issues; routes open-ended questions to Discussions and security reports to private advisories..github/PULL_REQUEST_TEMPLATE.md— forces a "how to verify" section, a screenshot for UI changes, a release-impact dropdown, and a Sparkle pre-flight that mirrors the hard rules inCLAUDE.md(monotonic semver, never touchSU_PUBLIC_KEY, no hand-edits to the cask or appcast, sync the landing repo'sVERSION).Why
Issues and PRs from outside contributors have been arriving without the basics — version, repro, what to actually click on to verify the change. The templates enforce that up front and surface the bricking-risk gotchas (Sparkle key, version monotonicity, cask drift) right next to the checkbox that would otherwise miss them.
How to verify
PULL_REQUEST_TEMPLATE.md.Risk
Repo-metadata only — no code paths or build scripts touched. Worst case is a typo in a template, fixable in a follow-up.
Generated by Claude Code
Summary by CodeRabbit