Skip to content

Commit dc1953a

Browse files
authored
Update the PR template to include the new Changelog format (#5477)
1 parent f542417 commit dc1953a

File tree

1 file changed

+27
-21
lines changed

1 file changed

+27
-21
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,50 @@
33
44
:wave: Just a quick reminder that this is a public repo. Please don't include any internal links or sensitive data (like PII, private code, customer names, site URLs, etc. Any fixes related to security should be discussed with Platform before opening a PR. If you're not sure if something is safe to share, please just ask!
55
6-
### BEFORE YOU PROCEED!!
7-
8-
If you’re editing a feature without changing the spirit of the implementation, fixing bugs, or performing upgrades, then please proceed!
9-
10-
If you’re adding a feature or changing the spirit of an existing implementation, please create a proposal in Cantina P2 using the MU Plugins Proposal Block Pattern. Please mention the [CODEOWNERS](.github/CODEOWNERS) of this repository and relevant stakeholders in your proposal :). Please be aware that any unplanned work may take some time to get reviewed. Thank you 🙇‍♀️🙇!
11-
126
## For external contributors!
137
148
Welcome! We look forward to your contribution! ❤️
159
-->
1610
## Description
1711
<!--
18-
A few sentences describing the overall goals of the Pull Request.
12+
A few sentences providing more context and describing the overall goals of the Pull Request.
1913
20-
Should include any special considerations, decisions, and links to relevant GitHub issues.
21-
22-
Please don't include internal or private links :)
14+
Should include any special considerations, decisions, and links to relevant publicly available sources (e.g. GitHub issues)
2315
-->
2416

2517
## Changelog Description
26-
<!--
27-
A description of the context of the change for a changelog. It should have a title, examples (if applicable), and why the change was made.
2818

29-
**Please keep the changelog title format same as in example below (### <Title>), as this is later used to generate the changelog entry title.**
19+
<!-- Changelogs are published for our customers. Well-written entries help them stay informed on platform changes and all of the great work that we do! -->
20+
21+
<!-- Write a concise description of changes in the relevant section.
22+
- Add new line items as needed.
23+
- Entries should follow the [Common Changelog Style Guide](https://github.com/vweevers/common-changelog).
24+
- Remove all unused sections before merging.
25+
- Proof-read.
26+
-->
3027

31-
Example for a plugin upgrade:
28+
### Added
29+
- <!-- e.g. "Added a new set of filters for MFA status" -->
30+
- <!-- e.g. "Dev-env: Added PHP 8.3 image" -->
3231

33-
### Plugin Updated: Jetpack 9.2.1
32+
### Removed
33+
- <!-- e.g. "Dropped support of Node.js 14" -->
34+
-
35+
36+
### Fixed
37+
- <!-- e.g. "Fixed a bug causing blank lines in content to be ignored when using the Regex Parser" -->
38+
39+
### Changed
40+
- <!-- e.g. "Increased priority of wp_mail_from filter in VIP Dashboard to prevent unintentional overriding" -->
41+
- <!-- e.g. "HyperDB: Updated to latest version to fix PHP error with addslashes()" -->
3442

35-
We upgraded Jetpack 9.2 to Jetpack 9.2.1.
3643

37-
Not a lot of significant changes in this patch release, just bugfixes and compatibility improvements.
38-
-->
3944
## Pre-review checklist
4045

4146
Please make sure the items below have been covered before requesting a review:
4247

43-
- [ ] This change works and has been tested locally (or has an appropriate fallback).
44-
- [ ] This change works and has been tested on a Go sandbox.
48+
- [ ] This change works and has been tested locally or in Codespaces (or has an appropriate fallback).
49+
- [ ] This change works and has been tested on a sandbox.
4550
- [ ] This change has relevant unit tests (if applicable).
4651
- [ ] This change uses a rollout method to ease with deployment (if applicable - especially for large scale actions that require writes).
4752
- [ ] This change has relevant documentation additions / updates (if applicable).
@@ -52,6 +57,7 @@ Please make sure the items below have been covered before requesting a review:
5257
- [ ] VIP staff: Ensure any alerts added/updated conform to internal standards (see internal documentation).
5358

5459
## Steps to Test
60+
5561
<!--
5662
Outline the steps to test and verify the PR here.
5763
@@ -61,4 +67,4 @@ Example:
6167
1. Go to `wp-admin` > `Tools` > `Bakery`
6268
1. Click on "Bake Cookies" button.
6369
1. Verify cookies are delicious.
64-
-->
70+
-->

0 commit comments

Comments
 (0)