Skip to content

Commit 384c314

Browse files
authored
docs: PR template updates (#776)
1 parent b26ea3b commit 384c314

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

.github/pull_request_template.md renamed to .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,31 @@
1-
## Title of this pull request
1+
Link(s) to demo pages where this element can be viewed (recommend using netlify link and not sandboxes that require VPN access):
2+
- [Link](https://5e6089f7c8e38b0008963801--happy-galileo-ea79c4.netlify.com/examples/)
3+
4+
---
5+
6+
### For new components
27

38
* Link to discovery documentation (should contain all the planning and requirements for this work):
4-
- See the `DISCOVERY.md` template at the root of the project
5-
* Link(s) to demo pages where this element can be viewed:
9+
- See the `DISCOVERY.md` template at the root of the project; this can be copied and stored in your component folder for reference.
610

7-
---
11+
### For component fixes and features
12+
13+
* Link to issue detailing the request:
814

915
### What has changed and why
16+
1017
Summarize files edited as part of this MR along with a brief description of what was changed/why.
1118

1219
*
1320

1421
### Testing instructions
22+
1523
Be sure to include detailed instructions on how your update can be tested by another developer.
1624

1725
1.
1826

1927
#### Browser requirements
28+
2029
Your component should work in all of the following environments:
2130

2231
- [ ] Latest 2 versions of Edge
@@ -30,17 +39,22 @@ Your component should work in all of the following environments:
3039
- [ ] iPad Pro Safari
3140
- [ ] Pixel 3 Chrome
3241

42+
#### Infrastructure requirements
43+
3344
Your repository infrastructure updates should work for at least:
3445
- [ ] Node v8.x
3546
- [ ] NPM v7.x
3647

3748
### Ready-for-merge Checklist
3849

39-
- [ ] Expected files: all files in this pull request are related to one feature request or issue (no stragglers)?
40-
- [ ] Did browser testing pass?
41-
- [ ] Did you update or add any necessary documentation (README.md, WHY.md, etc.)?
42-
- [ ] Was this feature demo'd and the design review approved?
43-
- [ ] Did you update the CHANGELOG.md file with a summary of this update?
50+
Check off items as they are completed. Feel free to delete items if they are not applicable to your PR.
51+
52+
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
53+
- [ ] Tests have been updated to cover these changes.
54+
- [ ] Browser testing passed.
55+
- [ ] Documentation (README.md, WHY.md, etc.) updated or added.
56+
- [ ] Link to the demo recording: []()
57+
- [ ] Approved by designer.
4458

4559

4660
**Be sure to share your updates with the [[email protected]](mailto:[email protected]) mailing list!**

0 commit comments

Comments
 (0)