Skip to content

Simplify GitHub PR template#47486

Merged
tbradsha merged 4 commits intotrunkfrom
update/simplify_pull_request_template
Mar 8, 2026
Merged

Simplify GitHub PR template#47486
tbradsha merged 4 commits intotrunkfrom
update/simplify_pull_request_template

Conversation

@tbradsha
Copy link
Copy Markdown
Contributor

@tbradsha tbradsha commented Mar 6, 2026

Fixes annoyances

Proposed changes

  • Remove colons from titles
  • Remove existing checkboxes in "Other information" section (see also pdWQjU-19D-p2#comment-1148)
  • Move changelog checkbox to "Other information" section
  • Rework product discussion section
  • Tweak some comments

Other information

  • Generate changelog entries for this PR (using AI).

Related product discussion/links

Does this pull request change what data or activity we track or use?

Testing instructions

🤷

@tbradsha tbradsha requested a review from a team March 6, 2026 14:11
@tbradsha tbradsha self-assigned this Mar 6, 2026
@tbradsha tbradsha added the [Status] Needs Review This PR is ready for review. label Mar 6, 2026
Copilot AI review requested due to automatic review settings March 6, 2026 14:11
@github-actions github-actions Bot added the Docs label Mar 6, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 6, 2026

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

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:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Comment thread .github/PULL_REQUEST_TEMPLATE.md
@anomiex anomiex requested review from jeherve and kraftbj March 6, 2026 14:25
Copy link
Copy Markdown
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

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 #
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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".

Copy link
Copy Markdown
Contributor Author

@tbradsha tbradsha Mar 6, 2026

Choose a reason for hiding this comment

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

I was going for "conservative" when purging things, but I'm happy to remove most any of the comments.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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).

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
* Go to '..'
*

## Changelog
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm on the fence; let's see what others say.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

### Other information:
*

- [ ] Have you written new tests for your changes, if applicable?
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 #
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor

@kraftbj kraftbj left a comment

Choose a reason for hiding this comment

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

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 #
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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?
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
<!-- 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. -->
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Minor nit - "p2 and/or Slack and/or Linear" but eh.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
* Go to '..'
*

## Changelog
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Copilot AI review requested due to automatic review settings March 8, 2026 07:48
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@tbradsha tbradsha requested review from anomiex, jeherve and kraftbj March 8, 2026 07:53
@tbradsha tbradsha merged commit f627d83 into trunk Mar 8, 2026
67 of 68 checks passed
@tbradsha tbradsha deleted the update/simplify_pull_request_template branch March 8, 2026 08:00
@github-actions github-actions Bot removed the [Status] Needs Review This PR is ready for review. label Mar 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants