Conversation
|
Thank you for your PR! When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖 Follow this PR Review Process:
If you have questions about anything, reach out in #jetpack-developers for guidance! |
There was a problem hiding this comment.
Pull request overview
Updates the repository’s default GitHub pull request template to be shorter and more focused, aiming to reduce boilerplate while still collecting key review context.
Changes:
- Simplifies section headings (e.g., removes trailing colons) and trims template scaffolding.
- Removes the “Other information” checklist block.
- Reworks the product discussion section into “Related product discussion/links” and tweaks instructional comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
anomiex
left a comment
There was a problem hiding this comment.
Looks reasonable to me; some suggestions inline.
Asking Kraft and Jeremy for input too.
| Please add testing instructions to projects/plugins/jetpack/to-test.md in a new commit as part of your PR. --> | ||
| <!-- a12s: If you have an expected version that you're aiming for the PR to add, please use the Milestone field to communicate it. If you leave it blank, that indicates there isn't a preference. --> | ||
|
|
||
| Fixes # |
There was a problem hiding this comment.
Personally, I find this useless too. If I'm fixing anything, it gets mentioned in "Proposed changes" or (what's now) "Related product discussion/links".
There was a problem hiding this comment.
I was going for "conservative" when purging things, but I'm happy to remove most any of the comments.
There was a problem hiding this comment.
I like that it's at the top, and not buried too far down in the PR description. It's easier to find that way. It's also a good reminder, for both humans and agents, that it's often useful to link issue and PR.
There was a problem hiding this comment.
Do you mean you like the comments at the top, or you like that I removed the comments so that the "Fixes #" is at the top?
There was a problem hiding this comment.
I like the Fixes # [or See #, etc] at the top to quickly connect to what the PR is trying to solve (versus how it's solving it in the PR itself).
| * Go to '..' | ||
| * | ||
|
|
||
| ## Changelog |
There was a problem hiding this comment.
Personally, I'd keep the "Other information" section just for this checkbox (but still delete the three checkboxes there), instead of having a separate section just for this checkbox. See also #47366.
There was a problem hiding this comment.
I'm on the fence; let's see what others say.
There was a problem hiding this comment.
Yeah, I'd say roll it into Other Information. I started doing that over in this PR before setting it aside before coming to the meetup #47366
| ### Other information: | ||
| * | ||
|
|
||
| - [ ] Have you written new tests for your changes, if applicable? |
There was a problem hiding this comment.
I wonder if this line in particular is more beneficial for Agents nowadays ; it may act as a reminder of something to do when working on changes.
I would also get rid of the other ones though.
Maybe we could keep the one about tests (maybe make it even stronger, since we are expected to always have tests after an incident for example p7H4VZ-5zm-p2 ), and bring the AI changelog one here too?
There was a problem hiding this comment.
I wonder if this line in particular is more beneficial for Agents nowadays ; it may act as a reminder of something to do when working on changes.
If it's mostly useful for agents, it seems that'd be something best put in a comment instead of a checkbox, or better yet directly in the agent instructions (useful while writing code) rather than the PR template (more useful after the code is written).
There was a problem hiding this comment.
Agree with both that we should encourage agents to do these things and that, for humans, I think it's not really useful anymore (became background noise after seeing it all these years). In my head, having a comment in the PR template is a nice late reminder of it, but I don't know that the agents actually process it in that way. Maybe in the /jetpack-pr skill or somewhere else to note that we want tests, etc
| Please add testing instructions to projects/plugins/jetpack/to-test.md in a new commit as part of your PR. --> | ||
| <!-- a12s: If you have an expected version that you're aiming for the PR to add, please use the Milestone field to communicate it. If you leave it blank, that indicates there isn't a preference. --> | ||
|
|
||
| Fixes # |
There was a problem hiding this comment.
I like that it's at the top, and not buried too far down in the PR description. It's easier to find that way. It's also a good reminder, for both humans and agents, that it's often useful to link issue and PR.
kraftbj
left a comment
There was a problem hiding this comment.
I'd keep Fixes # at the top — agree with Jeremy that it's a lightweight prompt worth preserving. Easy to find, good reminder for both humans and agents to link PRs to issues, and the cost of keeping it is near zero.
Rest of the cleanup looks good.
| Please add testing instructions to projects/plugins/jetpack/to-test.md in a new commit as part of your PR. --> | ||
| <!-- a12s: If you have an expected version that you're aiming for the PR to add, please use the Milestone field to communicate it. If you leave it blank, that indicates there isn't a preference. --> | ||
|
|
||
| Fixes # |
There was a problem hiding this comment.
I like the Fixes # [or See #, etc] at the top to quickly connect to what the PR is trying to solve (versus how it's solving it in the PR itself).
| ### Other information: | ||
| * | ||
|
|
||
| - [ ] Have you written new tests for your changes, if applicable? |
There was a problem hiding this comment.
Agree with both that we should encourage agents to do these things and that, for humans, I think it's not really useful anymore (became background noise after seeing it all these years). In my head, having a comment in the PR template is a nice late reminder of it, but I don't know that the agents actually process it in that way. Maybe in the /jetpack-pr skill or somewhere else to note that we want tests, etc
| <!-- If you're an Automattician, include a shortlink to the p2 discussion with Jetpack Product here. --> | ||
| <!-- Make sure any changes to existing products have been discussed and agreed upon --> | ||
| ## Related product discussion/links | ||
| <!-- If you're an Automattician, include a shortlink to the P2 and/or Slack discussions here. --> |
There was a problem hiding this comment.
Minor nit - "p2 and/or Slack and/or Linear" but eh.
| * Go to '..' | ||
| * | ||
|
|
||
| ## Changelog |
There was a problem hiding this comment.
Yeah, I'd say roll it into Other Information. I started doing that over in this PR before setting it aside before coming to the meetup #47366
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Fixes annoyances
Proposed changes
Other information
Related product discussion/links
Does this pull request change what data or activity we track or use?
Testing instructions
🤷