chore: rewrite PR template to match real scripts + Changesets flow#16
Conversation
The previous stub referenced `pnpm check` and `pnpm test:electron`, neither of which exist as scripts in package.json. Replace with the actual scripts (`typecheck`, `test:unit`, `test:smoke`) and add the Summary / Changes / Verification / Notes structure, plus a pointer to the Changesets release flow documented in CONTRIBUTING.md.
🦋 Changeset detectedLatest commit: f42a757 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughUpdates the PR template and adds a Changeset entry to require explicit Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 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)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/pull_request_template.md (1)
18-26: Minor: remove empty placeholder bullets in “## Changes”.Lines 24-26 contain
-placeholders that will render as empty bullets in the PR template. Not harmful, but it looks unfinished and can distract from the real “verification” guidance.Consider replacing the empty bullets with comment placeholders (e.g.
- <change description>) or removing one/more of them so only real items appear when the author edits.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/pull_request_template.md around lines 18 - 26, The PR template's "## Changes" section contains two empty bullet placeholders ("-") that render as blank list items; edit the "## Changes" block to remove those empty bullets or replace them with a clear placeholder such as "- <change description>" so authors see a meaningful prompt instead of empty list items; look for the "## Changes" header and the two lone "-" list entries and update them accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/pull_request_template.md:
- Around line 27-35: Replace the incorrect checklist commands "pnpm test:unit"
and "pnpm test:smoke" in the Verification section with the actual scripts used
by the repo: change "pnpm test:unit" to "pnpm test" and change "pnpm test:smoke"
to "pnpm test:electron" so the checklist reflects real commands; update the two
checklist items that currently mention "pnpm test:unit" and "pnpm test:smoke"
accordingly and keep the rest of the Verification items unchanged.
---
Nitpick comments:
In @.github/pull_request_template.md:
- Around line 18-26: The PR template's "## Changes" section contains two empty
bullet placeholders ("-") that render as blank list items; edit the "## Changes"
block to remove those empty bullets or replace them with a clear placeholder
such as "- <change description>" so authors see a meaningful prompt instead of
empty list items; look for the "## Changes" header and the two lone "-" list
entries and update them accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 4ecdade1-833d-4e43-9260-9928247044b3
📒 Files selected for processing (2)
.changeset/pr-template-rewrite.md.github/pull_request_template.md
Summary
The existing
.github/pull_request_template.mdis a 5-line stub. Replace it with a structured template (Summary / Changes / Verification / Notes for reviewers) that points contributors at the Changesets workflow and the README-update expectation for public API changes.This is the last bit of repo-docs scaffolding called out in the PR C deliverables for agent-labs-dev/nebula-desktop#153.
Changes
.github/pull_request_template.md:pnpm checkandpnpm test:electron(matchespackage.jsonandCONTRIBUTING.md).changeset/pr-template-rewrite.md) since this is repo metaVerification
checkandelectron-smokejobs unaffectedCONTRIBUTING.md(Releases section)package.json(pnpm check,pnpm test:electron).env*files includedNotes for reviewers
The verification checklist intentionally mirrors what
CONTRIBUTING.mdalready says, so contributors don't have to keep two lists in sync mentally. If you'd rather have the template stay terse and lean onCONTRIBUTING.mdfor the checklist, happy to slim it back down.Summary by CodeRabbit