Skip to content

chore: rewrite PR template to match real scripts + Changesets flow#16

Merged
jnsdls merged 2 commits into
mainfrom
t3code/pr-template
Apr 27, 2026
Merged

chore: rewrite PR template to match real scripts + Changesets flow#16
jnsdls merged 2 commits into
mainfrom
t3code/pr-template

Conversation

@jnsdls

@jnsdls jnsdls commented Apr 27, 2026

Copy link
Copy Markdown
Member

Summary

The existing .github/pull_request_template.md is 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

  • Rewrite .github/pull_request_template.md:
    • Add Summary / Changes / Notes-for-reviewers sections (only Summary + Verification existed before)
    • Verification checklist references pnpm check and pnpm test:electron (matches package.json and CONTRIBUTING.md)
    • Add a "changeset staged or empty" item so contributors don't break the release workflow
    • Add a "public API change reflected in README" item
    • Add a "no secrets / .env" item
  • Add an empty changeset (.changeset/pr-template-rewrite.md) since this is repo meta

Verification

  • No source/test changes; CI check and electron-smoke jobs unaffected
  • Empty changeset staged per CONTRIBUTING.md (Releases section)
  • Script names cross-checked against package.json (pnpm check, pnpm test:electron)
  • No secrets, tokens, or .env* files included

Notes for reviewers

The verification checklist intentionally mirrors what CONTRIBUTING.md already says, so contributors don't have to keep two lists in sync mentally. If you'd rather have the template stay terse and lean on CONTRIBUTING.md for the checklist, happy to slim it back down.

Summary by CodeRabbit

  • Chores
    • Updated pull request template with enhanced author guidance and a more detailed verification checklist requiring explicit local checks (lint/typecheck/tests/build) and conditional smoke tests
    • Added a "Notes for reviewers" section for contextual and security-sensitive callouts
    • Added a changeset configuration entry to document release/process expectations

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-bot

changeset-bot Bot commented Apr 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest 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

@coderabbitai

coderabbitai Bot commented Apr 27, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 5e4935a4-839e-45db-a276-88fa9784d504

📥 Commits

Reviewing files that changed from the base of the PR and between 6b4b648 and f42a757.

📒 Files selected for processing (1)
  • .github/pull_request_template.md
✅ Files skipped from review due to trivial changes (1)
  • .github/pull_request_template.md

📝 Walkthrough

Walkthrough

Updates the PR template and adds a Changeset entry to require explicit pnpm script checks (typecheck, unit, smoke where applicable), Changesets staging, and reviewer notes; no user-visible behavior changes. (49 words)

Changes

Cohort / File(s) Summary
Changeset Configuration
​.changeset/pr-template-rewrite.md
Adds a new changeset file documenting the PR-template rewrite, instructing use of actual pnpm scripts and the Changesets release workflow; no code/API changes.
PR Template Updates
.github/pull_request_template.md
Replaces the prior verification checklist with explicit guidance and checks: pnpm typecheck, pnpm test:unit, conditional electron smoke tests, pnpm changeset staging (or pnpm changeset --empty), README/API doc reminder, and a “Notes for reviewers” section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: rewriting the PR template to reference actual pnpm scripts and the Changesets workflow.
Description check ✅ Passed The description is comprehensive and well-structured, following the repository template with clear Summary, Changes, Verification, and Notes sections addressing the template update and changeset workflow integration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch t3code/pr-template

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between e2095ff and 6b4b648.

📒 Files selected for processing (2)
  • .changeset/pr-template-rewrite.md
  • .github/pull_request_template.md

Comment thread .github/pull_request_template.md
@jnsdls jnsdls merged commit 6f00559 into main Apr 27, 2026
3 checks passed
@jnsdls jnsdls deleted the t3code/pr-template branch April 27, 2026 23:33
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.

1 participant