Skip to content

Commit 9f72af6

Browse files
authored
Updates the PR template. (#631)
This is a content change for workflow reasons and has no impact on the end user.
1 parent bee6896 commit 9f72af6

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,16 @@
1-
<!-- Give your PR a recognizable title. For example: "FE-123: Add new prop to component" or "Resolve Issue #123: Fix bug in component" -->
2-
<!-- Your PR title will be visible in changelogs -->
1+
// Give your PR a recognizable title. For example: "FE-123: Add new prop to component" or "Resolve Issue #123: Fix bug in component" // Your PR title will be visible in changelogs
32

43
### What Changed
54

6-
<!--
7-
What changes does this PR propose?
8-
Provide screenshots or [screen recordings](https://getkap.co/) for any visual changes.
9-
-->
5+
// What changes does this PR propose? // Provide screenshots or [screen recordings](https://getkap.co/) for any visual changes.
106

117
### How To Test or Verify
128

13-
<!--
14-
Describe any steps that may help reviewers verify changes.
15-
Anything beyond basic unit testing, such as assistive tech usage, or special interactions.
16-
-->
9+
// Describe any steps that may help reviewers verify changes. // Anything beyond basic unit testing, such as assistive tech usage, or special interactions.
1710

1811
### PR Checklist
1912

20-
Below are some checklists to follow for the correct procedure in different circumstance. The first list ("All PRs Checklist") should be followed for ALL PRs. The next 2 are addative to this list depending on what type of PR you are using.
13+
Below are some checklists to follow for the correct procedure in different circumstance. The first list ("All PRs Checklist") should be followed for ALL PRs. The next 2 are additive to this list depending on what type of PR you are using.
2114

2215
For example: If you are submitting a content change to one of the support documents, your checklist would include the:
2316

@@ -33,14 +26,15 @@ If you are submitting a feature addition, enhancement, or bug fix, your checklis
3326

3427
- [ ] Give your pull request a meaningful name.
3528
- [ ] Use lowercase filenames.
36-
- [ ] Pull request approval from #uxfe or #front-end-guild
29+
- [ ] Pull request approval from the FE team or content experts that isn't the content creator.
3730

3831
#### Content Changes Checklist
3932

40-
- [ ] Check that your article appears here or in a [Netlify deploy preview](https://app.netlify.com/sites/support-docs/deploys) and looks correct.
33+
- [ ] Check that your article looks correct in the preview here or in a [Netlify deploy preview](https://app.netlify.com/sites/support-docs/deploys).
4134
- [ ] Check the links in your article.
4235
- [ ] Check the images in your article (if there are any)
4336
- [ ] Check to make sure you are using markdown appropriately as outlined in `examples/article.md` in the root of the project directory and on the momentum doc's [preface article](https://support.sparkpost.com/momentum/4/4-preface)
37+
- [ ] Check to make sure the [Copy and Tone Guidelines are followed](https://docs.google.com/document/d/1dej9J7N9M8lcbJXnT9kxyNB_EFBPHIBLZBbHaxRWqhQ/edit).
4438

4539
#### Development Changes Checklist (some checks are automatic github actions and will not be listed here. ie. "all tests pass")
4640

0 commit comments

Comments
 (0)