Skip to content

Commit 7cb02be

Browse files
castastrophecastastrophe
authored
docs: Update templates and guides (#905)
* docs Add the code of conduct from PF, update templates, create a contribution guide * docs documentation update * Update FF version on RHEL * Make mobile requirements & the browser checklist more generic * Update update_documentation.md * docs Add note about pull request templates
1 parent 99143bb commit 7cb02be

File tree

9 files changed

+343
-20
lines changed

9 files changed

+343
-20
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve our project
4+
labels: bug, sev-1
5+
---
6+
7+
<!-- Hello! Please read the [Contributing Guidelines](CONTRIBUTING.md) before submitting an issue. -->
8+
9+
## Description of the issue
10+
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
### Impacted component(s)
14+
15+
-
16+
17+
### Steps to reproduce
18+
19+
1. Go to '...'
20+
2. Click on '....'
21+
3. Scroll to '....'
22+
4. Check console
23+
5. See error
24+
25+
### Expected behavior
26+
27+
<!-- A clear and concise description of what you expected to happen. -->
28+
29+
### Screenshots
30+
31+
<!-- If applicable, add screenshots to help demonstrate the issue. -->
32+
33+
## Related issues
34+
35+
- (#100) Description
36+
37+
<!--
38+
Please update the labels for this component to reflect the topic of the issue: accessibility, doc / demo, functionality, integration, styles-only, tests, tools.
39+
40+
Note also the severity level; all new issues default to severity level 1 which is low priority. If you feel this issue deserves more attention, please set the label to sev-2 or sev-3.
41+
-->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature request
3+
about: Describe the feature you would like added
4+
labels: feature, sev-1
5+
---
6+
7+
<!-- Hello! Please read the [Contributing Guidelines](CONTRIBUTING.md) before submitting an issue. -->
8+
9+
## Description of the requested feature
10+
11+
<!-- A clear and concise description of the feature being requested. -->
12+
13+
14+
### Impacted component(s)
15+
16+
-
17+
18+
19+
## Related issues
20+
21+
- (#100) Description
22+
23+
24+
<!--
25+
Please update the labels for this component to reflect the topic of the issue: accessibility, doc / demo, functionality, integration, styles-only, tests, tools.
26+
27+
Note also the severity level; all new issues default to severity level 1 which is low priority. If you feel this issue deserves more attention, please set the label to sev-2 or sev-3.
28+
-->

‎.github/ISSUE_TEMPLATE/new_component.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: New component
3+
about: Outline the requirements for a new component.
4+
labels: Design System, new component request, sev-1
5+
---
6+
7+
# Component name:
8+
9+
> General description of the component goal.
10+
11+
12+
## Design specification
13+
14+
<!--
15+
Snapshots and link to mock-ups for this component. Should cover themes and states with guidelines for spacing, typography, and structure. Breakpoint details for desktop, tablet, and mobile or general guidance for responsive changes.
16+
-->
17+
18+
19+
## Accessibility
20+
21+
<!--
22+
Guidance for keyboard navigation and screen-reader engagement. [Best practice documentation](https://usability.yale.edu/web-accessibility/articles) from Yale University.
23+
-->
24+
25+
26+
## Interaction
27+
28+
<!-- General guidance for how a user should interact with this component. -->
29+
30+
31+
## Analytics
32+
33+
<!-- How will this component be tracked? Are any custom events needed to hook into the state of the component? -->

‎.github/PULL_REQUEST_TEMPLATE/new_component.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
name: New component
3+
about: Outline the requirements for a new component.
4+
labels: feature
5+
---
6+
7+
## New component
8+
9+
A brand new web component.
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.
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!**

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

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,71 @@
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-
41
---
2+
name: Component updates
3+
about: Outline the updates for this component(s).
4+
labels:
5+
---
6+
7+
## Component updates
8+
9+
Updates relating to a specific component(s).
10+
11+
12+
### Related issues
513

6-
### For new components
14+
- (#100) Description
715

8-
* Link to discovery documentation (should contain all the planning and requirements for this work):
9-
- See the `DISCOVERY.md` template at the root of the project; this can be copied and stored in your component folder for reference.
1016

11-
### For component fixes and features
17+
### Preview
18+
19+
Link(s) to demo page(s) where this element can be viewed:
20+
- [Link](https://5e6089f7c8e38b0008963801--happy-galileo-ea79c4.netlify.com/examples/)
1221

13-
* Link to issue detailing the request:
1422

1523
### What has changed and why
1624

1725
Summarize files edited as part of this MR along with a brief description of what was changed/why.
1826

19-
*
27+
-
28+
2029

2130
### Testing instructions
2231

2332
Be sure to include detailed instructions on how your update can be tested by another developer.
2433

2534
1.
2635

36+
2737
#### Browser requirements
2838

2939
Your component should work in all of the following environments:
3040

3141
- [ ] Latest 2 versions of Edge
3242
- [ ] Internet Explorer 11 (should be useable, not pixel perfect)
3343
- [ ] Latest 2 versions of Firefox (one on Mac OS, one of Windows OS)
34-
- [ ] Firefox 60.7.2 (or latest version for Red Hat Enterprise Linux distribution)
44+
- [ ] Firefox 68 (or latest version for Red Hat Enterprise Linux distribution)
3545
- [ ] Latest 2 versions of Chrome (one on Mac OS, one of Windows OS)
3646
- [ ] Latest 2 versions of Safari
37-
- [ ] Galaxy S9 Firefox
38-
- [ ] iPhone X Safari
39-
- [ ] iPad Pro Safari
40-
- [ ] Pixel 3 Chrome
47+
- [ ] Android mobile device (such as the Galaxy S9)
48+
- [ ] Apple mobile device (such as the iPhone X)
49+
- [ ] Apple tablet device (such as the iPhone Pro)
4150

42-
#### Infrastructure requirements
43-
44-
Your repository infrastructure updates should work for at least:
45-
- [ ] Node v8.x
46-
- [ ] NPM v7.x
4751

4852
### Ready-for-merge Checklist
4953

50-
Check off items as they are completed. Feel free to delete items if they are not applicable to your PR.
54+
Check off items as they are completed. Feel free to delete items if they are not applicable.
5155

5256
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
5357
- [ ] Tests have been updated to cover these changes.
5458
- [ ] Browser testing passed.
59+
- [ ] Repository compiles and tests pass.
60+
- [ ] Changelog updated.
5561
- [ ] Documentation (README.md, WHY.md, etc.) updated or added.
5662
- [ ] Link to the demo recording: []()
5763
- [ ] Approved by designer.
5864

5965

66+
### Merging
67+
68+
Please **squash** when merging and ensure your commit message uses [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) formatting.
69+
6070
**Be sure to share your updates with the [[email protected]](mailto:[email protected]) mailing list!**
6171

‎.github/PULL_REQUEST_TEMPLATE/update_documentation.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Update/add documentation
3+
about: Describe the documentation updates
4+
labels: doc / demo
5+
---
6+
7+
## Documentation updates
8+
9+
10+
### What has changed and why
11+
12+
Summarize files edited as part of this MR along with a brief description of what was changed/why.
13+
14+
-
15+
16+
17+
### Ready-for-merge Checklist
18+
19+
Check off items as they are completed. Feel free to delete items if they are not applicable to your PR.
20+
21+
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
22+
- [ ] Documentation updates are clear and concise.
23+
24+
### Merging
25+
26+
Please **squash** when merging and ensure your commit message uses [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) formatting. Documentation updates do not require a CHANGELOG entry.
27+
28+
**Be sure to share your updates with the [[email protected]](mailto:[email protected]) mailing list!**
29+

‎.github/PULL_REQUEST_TEMPLATE/update_infrastructure.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Infrastructure
3+
about: Describe the proposed changes to the project infrastructure.
4+
labels: infrastructure
5+
---
6+
7+
## Infrastructure updates
8+
9+
Updates relating to the overall architecture or infrastructure of the project; not component-specific changes. Thank you for submitting a pull request!
10+
11+
12+
### What has changed and why
13+
14+
Summarize files edited as part of this MR along with a brief description of what was changed/why.
15+
16+
-
17+
18+
19+
### Testing instructions
20+
21+
Be sure to include detailed instructions on how your update can be tested by another developer.
22+
23+
1.
24+
25+
26+
#### Requirements
27+
28+
Your repository infrastructure updates should work for at least:
29+
- [ ] Node v10.x
30+
- [ ] NPM v6.x
31+
32+
33+
### Ready-for-merge Checklist
34+
35+
Check off items as they are completed. Feel free to delete items if they are not applicable to your PR.
36+
37+
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
38+
- [ ] Repository compiles and tests pass.
39+
- [ ] Changelog updated.
40+
- [ ] Documentation updated or added, if necessary.
41+
- [ ] Link to the demo recording: []()
42+
43+
### Merging
44+
45+
Please **squash** when merging and ensure your commit message uses [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) formatting.
46+
47+
**Be sure to share your updates with the [[email protected]](mailto:[email protected]) mailing list!**
48+

‎CODE_OF_CONDUCT.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
This project is governed by the [Contributor Covenant version 1.4][1]. All contributors and participants agree to abide by its terms. To report violations, send an email to [[email protected]][2].
2+
3+
[1]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
4+
[2]: mailto:[email protected]

0 commit comments

Comments
 (0)