docs: add PR template#11290
Merged
Merged
Conversation
cceff84 to
713a52c
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new pnpm bugs CLI command (including tests and a changeset) and also introduces a repository PR template; together these changes expand pnpm’s CLI surface while adding contributor-process documentation.
Changes:
- Add a new
pnpm bugscommand wired into the CLI command registry, and remove it from the “not implemented” set. - Add Jest coverage for
pnpm bugsbehavior, plus test-runner utilities updates for resolving pnpm/pnpx bin locations. - Add a PR template and a changeset declaring a minor release for the new command.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
pnpm/test/utils/execPnpm.ts |
Changes how test utilities locate pnpm.mjs/pnpx.mjs binaries. |
pnpm/test/bugs.ts |
Adds tests for the new pnpm bugs command. |
pnpm/src/cmd/notImplemented.ts |
Removes bugs from the not-implemented commands list. |
pnpm/src/cmd/index.ts |
Registers the new bugs command in the CLI. |
pnpm/src/cmd/bugs.ts |
Implements pnpm bugs (URL discovery + platform opener). |
.github/pull_request_template.md |
Adds a PR template with What/Why/With/How sections. |
.changeset/pnpm-bugs-command.md |
Declares a minor changeset for the new command. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
713a52c to
4d12459
Compare
a635f2b to
30707be
Compare
Contributor
|
Maybe the changesets requirement could be communicated here somehow? |
Member
|
The funniest thing is that you yourself did not use the template in this PR |
30707be to
75eea28
Compare
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
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 (3)
✅ Files skipped from review due to trivial changes (2)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughA new pull request template is added at ChangesPull Request and Submission Process Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Tools execution failed with the following error: Failed to run tools: 13 INTERNAL: Received RST_STREAM with code 2 (Internal server error) 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 |
Code Review by Qodo
1. Ambiguous rationale location
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/pull_request_template.md:
- Around line 1-19: Add a new "Changesets" section to the pull request template
that guides contributors on the required changeset process. Insert this section
after the "Related Issues" section and before the "How to Validate" section. The
section should include clear instructions on running `pnpm changeset` to
generate a changeset file and reference the CONTRIBUTING guide for additional
details.
🪄 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: 4f67d59c-8760-481f-b77a-9cfa96419679
📒 Files selected for processing (1)
.github/pull_request_template.md
75eea28 to
2d9694b
Compare
|
Code review by qodo was updated up to the latest commit 2d9694b |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/pull_request_template.md (1)
15-17: 💤 Low valueConsider adding a language specifier to the fenced code block (minor linting).
Markdownlint flagged the fenced code block at line 15 as missing a language identifier (MD040). While this is a placeholder for contributor input, adding a specifier (e.g.,
```markdownor```text) would satisfy the linting rule without compromising usability. This is optional and can be deferred if you prefer to keep the block language-agnostic.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/pull_request_template.md around lines 15 - 17, Add a language specifier to the fenced code block that contains the text "Explain what changed and why. Reference issues here too (Closes `#123`)." by modifying the opening fence from ``` to ```markdown or ```text. This will satisfy the markdownlint MD040 rule which requires language identifiers on fenced code blocks, while maintaining the placeholder's usability for contributors.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.github/pull_request_template.md:
- Around line 15-17: Add a language specifier to the fenced code block that
contains the text "Explain what changed and why. Reference issues here too
(Closes `#123`)." by modifying the opening fence from ``` to ```markdown or
```text. This will satisfy the markdownlint MD040 rule which requires language
identifiers on fenced code blocks, while maintaining the placeholder's usability
for contributors.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 41a74191-8a7e-4e85-be2c-bc27f96d0006
📒 Files selected for processing (1)
.github/pull_request_template.md
2d9694b to
390f7ef
Compare
|
Code review by qodo was updated up to the latest commit 390f7ef |
390f7ef to
fff8538
Compare
fff8538 to
11ac009
Compare
Comment on lines
+26
to
+27
| - [ ] Added a changeset (`pnpm changeset`) if this PR changes any published | ||
| package. Keep it short and written for pnpm users — it becomes a release note. |
There was a problem hiding this comment.
1. Changeset guidance inconsistent 🐞 Bug ⚙ Maintainability
The PR template’s changeset checklist item omits the newly-added rule that implementation rationale belongs in the commit message, making contributor guidance inconsistent across docs and increasing the chance of rationale text being placed into release-note changesets.
Agent Prompt
### Issue description
The PR template checklist mentions keeping changesets concise for pnpm users, but it does not include the repo’s new rule that implementation rationale should go in the commit message (not the changeset). This creates inconsistent instructions between the PR template and contributor docs.
### Issue Context
Both `AGENTS.md` and `CONTRIBUTING.md` were updated in this PR to explicitly state: “Implementation rationale belongs in the commit message, not the changeset.” The PR template should match that guidance.
### Fix Focus Areas
- .github/pull_request_template.md[24-27]
- AGENTS.md[212-215]
- CONTRIBUTING.md[195-196]
### Suggested change
Update the checklist item to include the same sentence, e.g. append: “Implementation rationale belongs in the commit message, not the changeset.”
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
Code review by qodo was updated up to the latest commit fff8538 |
Comment on lines
+30
to
+31
| - [ ] Added a changeset (`pnpm changeset`) if this PR changes any published | ||
| package. Keep it short and written for pnpm users — it becomes a release note. |
There was a problem hiding this comment.
1. Missing pnpm changeset reminder 🐞 Bug ⚙ Maintainability
The PR template checklist asks authors to add a changeset but doesn’t mention the repo rule to explicitly include a "pnpm" entry (with the appropriate bump) when the pnpm CLI needs a version bump. This documentation gap increases the chance contributors follow the template yet still produce an incomplete changeset compared to the required process.
Agent Prompt
## Issue description
The PR template changeset checklist item does not remind contributors of the documented requirement to explicitly include a `"pnpm"` entry in the changeset when the CLI needs a version bump.
## Issue Context
`AGENTS.md` states that `"pnpm"` must be explicitly included in changesets to ensure the CLI gets the intended bump.
## Fix Focus Areas
- .github/pull_request_template.md[30-31]
- AGENTS.md[214-216]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
Code review by qodo was updated up to the latest commit 11ac009 |
11ac009 to
c5a1645
Compare
zkochan
approved these changes
Jun 18, 2026
| ## Changesets (TypeScript only) | ||
|
|
||
| If your changes affect published packages, you MUST create a changeset file in the `.changeset` directory. The changeset file should describe the change and specify the packages that are affected with the pending version bump types: patch, minor, or major. | ||
| If your changes affect published packages, you MUST create a changeset file in the `.changeset` directory. The changeset file should describe the change and specify the packages that are affected with the pending version bump types: patch, minor, or major. Write the description for pnpm users and keep it concise — it becomes a release note. Implementation rationale belongs in the commit message, not the changeset. |
There was a problem hiding this comment.
1. Ambiguous rationale location 🐞 Bug ⚙ Maintainability
AGENTS.md/CONTRIBUTING.md now say “implementation rationale belongs in the commit message”, but this repo’s PR workflow expects squash merges where the durable commit message is the squash commit body derived from the PR. This wording can mislead contributors into editing individual commit messages instead of filling the PR’s “Squash Commit Body”, reducing the chance rationale is preserved in the final history.
Agent Prompt
### Issue description
`AGENTS.md` and `CONTRIBUTING.md` instruct contributors to put implementation rationale in the “commit message”, but the repo’s workflow expects squash merges where the durable commit text comes from the PR’s squash commit body. This mismatch can confuse contributors about where to place rationale.
### Issue Context
The PR template explicitly requests rationale in the squash commit body, and repo config references a squash-title convention.
### Fix Focus Areas
- AGENTS.md[212-216]
- CONTRIBUTING.md[193-201]
- .github/pull_request_template.md[11-18]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
Code review by qodo was updated up to the latest commit c5a1645 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds
pull_request_template.md.Summary by CodeRabbit
Documentation / Chores