Skip to content

Commit a413f5e

Browse files
authored
feat: Add a default template for PRs
1 parent 49c6146 commit a413f5e

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
name: Default template
3+
about: Generic template
4+
labels: "feature, needs: AT updates, needs: changelog, needs: branch testing, priority: low"
5+
---
6+
7+
## Component name
8+
9+
<!-- tldr; goes here -->
10+
11+
12+
### Related issue
13+
14+
- (#100) Description
15+
16+
17+
### Preview
18+
19+
<!-- Suggest linking to Netlify or a public sandbox; not a resource behind a log-in or VPN -->
20+
Link(s) to demo page(s) where this element can be viewed:
21+
- [Link](https://5e6089f7c8e38b0008963801--happy-galileo-ea79c4.netlify.com/examples/)
22+
23+
24+
### What has changed and why
25+
26+
<!-- See the `DISCOVERY.md` template at the root of the project; this can be copied and stored in your component folder for reference. -->
27+
28+
Link to discovery documentation (should contain all the planning and requirements for this work):
29+
-
30+
31+
32+
### Testing instructions
33+
34+
<!-- Be sure to include detailed instructions on how your update can be tested by another developer. -->
35+
36+
1.
37+
38+
39+
#### Browser requirements
40+
41+
Your component should work in all of the following environments:
42+
43+
- [ ] Latest 2 versions of Edge
44+
- [ ] Internet Explorer 11 (should be useable, not pixel perfect)
45+
- [ ] Latest 2 versions of Firefox (one on Mac OS, one of Windows OS)
46+
- [ ] Firefox 68 (or latest version for Red Hat Enterprise Linux distribution)
47+
- [ ] Latest 2 versions of Chrome (one on Mac OS, one of Windows OS)
48+
- [ ] Latest 2 versions of Safari
49+
- [ ] Android mobile device (such as the Galaxy S9)
50+
- [ ] Apple mobile device (such as the iPhone X)
51+
- [ ] Apple tablet device (such as the iPhone Pro)
52+
53+
54+
### Ready-for-merge Checklist
55+
56+
Check off items as they are completed. Feel free to delete items if they are not applicable.
57+
58+
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
59+
- [ ] Tests have been updated to cover these changes.
60+
- [ ] Browser testing passed.
61+
- [ ] Repository compiles and tests pass.
62+
- [ ] Changelog updated (not needed for documentation updates).
63+
- [ ] Documentation (README.md, WHY.md, etc.) updated or added.
64+
- [ ] Link to the demo recording: []()
65+
- [ ] Approved by designer.
66+
67+
68+
### Merging
69+
70+
Please **squash** when merging and ensure your commit message uses [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) formatting.
71+
72+
**Be sure to share your updates with the [[email protected]](mailto:[email protected]) mailing list!**

0 commit comments

Comments
 (0)