Skip to content

Commit 6f00559

Browse files
authored
chore: rewrite PR template to match real scripts + Changesets flow (#16)
## 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](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 - [x] No source/test changes; CI `check` and `electron-smoke` jobs unaffected - [x] Empty changeset staged per `CONTRIBUTING.md` (Releases section) - [x] Script names cross-checked against `package.json` (`pnpm check`, `pnpm test:electron`) - [x] 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. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## 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 <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent e2095ff commit 6f00559

2 files changed

Lines changed: 41 additions & 2 deletions

File tree

.changeset/pr-template-rewrite.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
---
3+
4+
Repo meta: rewrite `.github/pull_request_template.md` to reference real `pnpm` scripts (`typecheck`, `test:unit`, `test:smoke`) and the Changesets release flow. No user-visible change.

.github/pull_request_template.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,41 @@
1+
<!--
2+
Thanks for opening a PR. Fill the sections below so reviewers can land
3+
this without context-switching.
4+
5+
CI runs `pnpm check` (lint + typecheck + test + build) and the Playwright
6+
`_electron` smoke test (`pnpm test:electron`) on every PR. Releases happen
7+
via Changesets — when this PR lands on `main`, the release workflow opens
8+
(or updates) a "Version Packages" PR consolidating pending changesets.
9+
Merging that PR cuts a release.
10+
11+
See CONTRIBUTING.md for the full flow.
12+
-->
13+
114
## Summary
215

16+
<!-- One to three sentences: what changes and why. Link the issue if
17+
there is one (e.g. "Closes #42"). -->
18+
19+
## Changes
20+
21+
<!-- Bulleted list of concrete changes. Call out anything subtle
22+
(broadening a public type, touching CDP wiring, changing a tool's
23+
input schema, adjusting the loopback bind / HTTP defaults). -->
24+
25+
-
26+
-
27+
328
## Verification
429

5-
- [ ] `pnpm check`
6-
- [ ] `pnpm test:electron` if Electron/CDP behavior changed
30+
- [ ] `pnpm check` passes locally (lint + typecheck + test + build)
31+
- [ ] If this touches CDP wiring or any bundled tool, `pnpm test:electron` passes
32+
- [ ] A changeset is staged (`.changeset/<name>.md`) **or** this PR is genuinely no-op for users (`pnpm changeset --empty`)
33+
- [ ] Public API changes (exports from `src/index.ts`) are reflected in `README.md`
34+
- [ ] No secrets, tokens, or `.env*` files included
35+
36+
## Notes for reviewers
37+
38+
<!-- Anything not obvious from the diff: trade-offs considered,
39+
alternatives rejected, follow-ups intentionally left out. For
40+
security-sensitive changes, please flag explicitly — see SECURITY.md
41+
for the vuln disclosure process. -->

0 commit comments

Comments
 (0)