Skip to content
This repository was archived by the owner on Feb 23, 2024. It is now read-only.

Commit 103f4d5

Browse files
committed
Numerous tweaks to various GH templates.
- updated release pull request description template to be more condensed and require no editing. - moved some elements of release pull request items into pull request template (handled at the PR level instead of the release level). - updated the release pull request checklist templates to include mobile and desktop test coverage for ui changes.
1 parent 000c5f4 commit 103f4d5

File tree

4 files changed

+22
-54
lines changed

4 files changed

+22
-54
lines changed

.github/patch-initial-checklist.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Additionally, make sure to differentiate between things in the testing notes tha
3030
* Test to confirm blocks are available and work correctly in oldest supported WordPress version (e.g. 5.3).
3131
* Confidence check - check blocks are available and function.
3232
* Test to confirm new features/fixes are working correctly.
33+
* Test any UI changes in mobile and desktop views.
3334
* Smoke test – test a cross section of core functionality.
3435

3536
## Update Pull Request description and get approvals

.github/pull_request_template.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,26 @@ Fixes #
2020

2121
<!-- If your change has a visual component, add a screenshot here. A "before" screenshot would also be helpful. -->
2222

23-
### How to test the changes in this Pull Request:
23+
### Testing
24+
25+
#### Automated Tests
26+
* [ ] Changes in this PR are covered by Automated Tests.
27+
* [ ] Unit tests
28+
* [ ] E2E tests
29+
### Manual Testing
30+
31+
How to test the changes in this Pull Request:
2432

2533
1.
2634
2.
2735
3.
2836

2937
<!-- If you can, add the appropriate labels -->
3038

39+
### Performance Impact
40+
41+
<!-- Please document any known performance impact (positive or negative) here. If negative, provide some rationale for why this is an okay tradeoff or how this will be addressed. -->
42+
3143
### Changelog
3244

3345
> Add suggested changelog entry here.

.github/release-initial-checklist.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Additionally, make sure to differentiate between things in the testing notes tha
3434
* Test to confirm blocks are available and work correctly in oldest supported WordPress version (e.g. 5.3).
3535
* Confidence check - check blocks are available and function.
3636
* Test to confirm new features/fixes are working correctly.
37+
* Test any UI changes in mobile and desktop views.
3738
* Smoke test – test a cross section of core functionality.
3839

3940
## Update Pull Request description and get approvals

.github/release-pull-request.md

Lines changed: 7 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -12,74 +12,28 @@ This is the release pull request for WooCommerce Blocks plugin `{{version}}`.
1212

1313
## Communication
1414

15-
> This section is for any notes related to communicating the release. Please include any extra details with each item as needed.
16-
17-
18-
This release introduces:
19-
20-
21-
> In this section document a summary of what's in the release. Keep this brief, and link to the changelog for more detail.
22-
2315
### Prepared Updates
2416

25-
The following documentation, blog posts, and changelog updates are prepared for the release:
17+
Please leave a comment on this PR with links to the following:
2618

27-
28-
> In this section you are highlighting all the public facing documentation that is related to the release. Feel free to remove anything that doesn't apply for this release.
29-
30-
31-
**Release announcement:** *Link to release announcement post on developer.woocommerce.com (published after release)*
19+
* [ ] Release announcement (announcement post on developer.woocommerce.com published after release).
3220

3321
{{#if devNoteItems}}
3422
**Developer Notes** - The following issues require developer notes in the release post:
3523

3624
{{devNoteItems}}
3725
{{/if}}
3826

39-
40-
**Relevant developer documentation:**
41-
_Link(s) to any developer documentation related to the release_
42-
43-
**Happiness Engineering or Happiness / Support:**
44-
_Link to any special instructions or important support notes for this release._
27+
* [ ] Happiness engineering or Happiness/Support (if special instructions needed).
28+
* [ ] Relevant developer documentation (if applicable).
4529

4630

4731
## Quality
4832

49-
> This section is for any notes related to quality around the release Please include any extra details with each item as needed. This can include notes about why something isn't checked or expanding info on your response to an item.
50-
51-
* [ ] Changes in this release are covered by Automated Tests.
52-
53-
> This section is for confirming that the release changeset is covered by automated tests. If not, please leave some details on why not and any relevant information indicating confidence without those tests.
54-
55-
* [ ] Unit tests
56-
* [ ] E2E tests
57-
* [ ] for each supported WordPress and WooCommerce core versions.
58-
59-
* This release has been tested on the following platforms:
60-
* [ ] mobile
61-
* [ ] desktop
62-
63-
* [ ] This release affects public facing REST APIs.
64-
* [ ] It conforms to REST API versioning policy.
65-
66-
* [ ] This release impacts **other extensions** or **backward compatibility**.
67-
* [ ] The release changes the signature of public methods or functions
68-
* [ ] This is documented (see: *Enter a link to the documentation here*)
69-
* [ ] The release affects filters or action hooks.
70-
* [ ] This is documented (see: *Enter a link to the documentation here*)
71-
72-
* [ ] Link to **testing instructions** for this release: *Enter a link to the testing instructions here, ideally in /docs/testing/releases*
73-
74-
* [ ] The release has a negative performance impact on sites.
75-
* [ ] There are new assets (JavaScript or CSS bundles)
76-
* [ ] There is an increase to the size of JavaScrip or CSS bundles) *please include rationale for this increase*
77-
* [ ] Other negative performance impacts (if yes, include list below)
78-
79-
* [ ] The release has positive performance impact on sites. If checked, please document these improvements here.
33+
> This section is for things related to quality around the release.
8034
81-
## Additional Notes
35+
* [ ] Testing Instructions are included in this PR
8236

83-
> This section is for additional notes related to the release.
37+
* [ ] Any performance impacts are documented.
8438

8539
------

0 commit comments

Comments
 (0)