Skip to content

Commit 46a1356

Browse files
authored
chore: Updating a few templates with GitHub changes (#1692)
* chore: Updating a few templates with GitHub changes * chore: Update label
1 parent f25580b commit 46a1356

File tree

8 files changed

+49
-42
lines changed

8 files changed

+49
-42
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ labels: "bug, priority: low"
3232

3333
## Related issues
3434

35-
- (#100) Description
35+
<!-- Issue number (GitHub will automatically populate the issue title for you from this) -->
36+
- #100
3637

3738
<!--
3839
Please update the labels for this component to reflect the topic of the issue: accessibility, doc / demo, functionality, integration, styles-only, tests, tools.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ labels: "feature, priority: low"
1818

1919
## Related issues
2020

21-
- (#100) Description
21+
<!-- Issue number (GitHub will automatically populate the issue title for you from this) -->
22+
- #100
2223

2324

2425
<!--

.github/ISSUE_TEMPLATE/new_component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ about: Outline the requirements for a new component.
44
labels: "design system, new component request, priority: low"
55
---
66

7-
# Component name:
7+
# Component name: <component-name>
88

99
> General description of the component goal.
1010

.github/ISSUE_TEMPLATE/update_component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ about: Outline the update requirements for an existing component.
44
labels: "design system, update component request, priority: low"
55
---
66

7-
# Component name:
7+
# Component name: <component-name>
88

99
> Name/Description of the component being updated
1010

.github/PULL_REQUEST_TEMPLATE/new_component.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- Labels: feature, ready: branch testing, ready: browser testing, needs: code review, priority: low -->
1+
<!-- Labels: feature, ready: branch testing, ready: browser testing, ready: code review, priority: low -->
22

33
<!-- Thank you for submitting a pull request! -->
44
## New component: <component-name>
@@ -9,31 +9,29 @@ A brand new web component!
99

1010
### Related issue
1111

12-
<!-- Link to the issue requesting this new component -->
13-
- (#100) Description of issue
14-
15-
16-
### Preview
17-
18-
<!-- Suggest linking to Netlify or a public sandbox; not a resource behind a log-in or VPN -->
19-
Link(s) to demo page(s) where this element can be viewed:
20-
- [Link](https://deploy-preview-<pr_number>--happy-galileo-ea79c4.netlify.app/examples/)
21-
12+
<!-- Issue number (GitHub will automatically populate the issue title for you from this) -->
13+
- #100
2214

2315
### What has changed and why
2416

2517
<!-- See the `DISCOVERY.md` template at the root of the project; this can be copied and stored in your component folder for reference. -->
2618

27-
Link to discovery documentation (should contain all the planning and requirements for this work):
19+
Link to discovery documentation (should contain all the planning and requirements for this work; avoid internal-only links):
2820
-
2921

3022

3123
### Testing instructions
3224

3325
<!-- Be sure to include detailed instructions on how your update can be tested by another developer. -->
3426

35-
1.
36-
27+
- [ ] *Test feature 1*
28+
1. Step 1
29+
2. Step 2
30+
3. Validate feature
31+
- [ ] *Test feature 2*
32+
1. Step 1
33+
2. Step 2
34+
3. Validate feature
3735

3836
#### Browser requirements
3937

@@ -57,10 +55,10 @@ Check off items as they are completed. Feel free to delete items if they are no
5755
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
5856
- [ ] Tests have been updated to cover these changes.
5957
- [ ] Browser testing passed.
60-
- [ ] Changelog updated.
58+
- [ ] Changelog updated (required for fix and feat changes).
6159
- [ ] Documentation (README.md, WHY.md, etc.) updated or added.
62-
- [ ] Link to the demo recording: []()
63-
- [ ] Approved by designer.
60+
- [ ] Link to the demo recording (if applicable).
61+
- [ ] Designer approval.
6462

6563

6664
### Merging

.github/PULL_REQUEST_TEMPLATE/update_component.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
1-
<!-- Labels: feature, ready: branch testing, ready: browser testing, needs: code review, priority: low -->
1+
<!-- Labels: feature, ready: branch testing, ready: browser testing, ready: code review, priority: low -->
22

33
<!-- Thank you for submitting a pull request! -->
44
## Component updates: <component-name>
55

6+
<!-- Tell us a little bit about these updates -->
67
Updates relating to a specific component(s).
78

89

910
### Related issues
1011

11-
- (#100) Description of issue
12-
13-
14-
### Preview
15-
16-
<!-- Suggest linking to Netlify or a public sandbox; not a resource behind a log-in or VPN -->
17-
Link(s) to demo page(s) where this element can be viewed:
18-
- [Link](https://deploy-preview-<pr_number>--happy-galileo-ea79c4.netlify.app/examples/)
19-
12+
<!-- Issue number (GitHub will automatically populate the issue title for you from this) -->
13+
- #100
2014

2115
### What has changed and why
2216

@@ -29,7 +23,14 @@ Link(s) to demo page(s) where this element can be viewed:
2923

3024
<!-- Be sure to include detailed instructions on how your update can be tested by another developer. -->
3125

32-
1.
26+
- [ ] *Test feature 1*
27+
1. Step 1
28+
2. Step 2
29+
3. Validate feature
30+
- [ ] *Test feature 2*
31+
1. Step 1
32+
2. Step 2
33+
3. Validate feature
3334

3435

3536
#### Browser requirements
@@ -54,10 +55,10 @@ Check off items as they are completed. Feel free to delete items if they are no
5455
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
5556
- [ ] Tests have been updated to cover these changes.
5657
- [ ] Browser testing passed.
57-
- [ ] Changelog updated.
58-
- [ ] Documentation (README.md, WHY.md, etc.) updated or added.
59-
- [ ] Link to the demo recording: []()
60-
- [ ] Approved by designer.
58+
- [ ] Changelog updated (required for fix and feat changes).
59+
- [ ] Documentation (README.md, WHY.md, etc.) updated or added, if necessary.
60+
- [ ] Link to the demo recording (if applicable).
61+
- [ ] Designer approval.
6162

6263

6364
### Merging

.github/PULL_REQUEST_TEMPLATE/update_documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- Labels: doc, needs: code review, priority: low -->
1+
<!-- Labels: doc, ready: code review, priority: low -->
22

33
<!-- Thank you for submitting a pull request! -->
44
## Documentation updates

.github/PULL_REQUEST_TEMPLATE/update_infrastructure.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- Labels: tools, ready: branch testing, needs: code review, priority: low -->
1+
<!-- Labels: tools, ready: branch testing, ready: code review, priority: low -->
22

33
<!-- Thank you for submitting a pull request! -->
44
## Infrastructure updates
@@ -17,18 +17,24 @@ Updates relating to the overall architecture or infrastructure of the project; n
1717

1818
<!-- Be sure to include detailed instructions on how your update can be tested by another developer. -->
1919

20-
1.
21-
20+
- [ ] *Test feature 1*
21+
1. Step 1
22+
2. Step 2
23+
3. Validate feature
24+
- [ ] *Test feature 2*
25+
1. Step 1
26+
2. Step 2
27+
3. Validate feature
2228

2329
### Ready-for-merge Checklist
2430

2531
<!-- Check off items as they are completed. Feel free to delete items if they are not applicable to your PR. -->
2632

2733
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
2834
- [ ] Repository compiles and tests pass.
29-
- [ ] Changelog updated.
35+
- [ ] Changelog updated (required for fix and feat changes).
3036
- [ ] Documentation updated or added, if necessary.
31-
- [ ] Link to the demo recording: []()
37+
- [ ] Link to the demo recording (if applicable).
3238

3339
### Merging
3440

0 commit comments

Comments
 (0)