Skip to content

Commit 4f321b9

Browse files
authored
docs: update contributing documentation and PR template (#1411)
1 parent ce254fb commit 4f321b9

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

.github/CONTRIBUTING.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,12 @@ commands are available:
6565
template.
6666

6767
See Garden's [development documentation](/docs/development.md) for package
68-
implementation requirements.
68+
implementation requirements. In general, your code will be expected to follow
69+
documented standards and prevailing conventions. If you feel the need to
70+
introduce a new or novel pattern, please start a new
71+
[discussion](https://github.com/zendeskgarden/react-components/discussions) or
72+
open an [issue](https://github.com/zendeskgarden/react-components/issues) for
73+
consideration by the core team.
6974

7075
## Pull Request Workflow
7176

.github/PULL_REQUEST_TEMPLATE.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,13 @@
1919

2020
## Checklist
2121

22-
- [ ] :ok_hand: design updates are Garden Designer approved (add the
23-
designer as a reviewer)
22+
<!-- check the items below that will be completed prior to merge.
23+
strikethrough any item text that does not apply to this PR. -->
24+
25+
- [ ] :ok_hand: design updates will be Garden Designer approved (add the designer as a reviewer)
2426
- [ ] :globe_with_meridians: demo is up-to-date (`yarn start`)
2527
- [ ] :arrow_left: renders as expected with reversed (RTL) direction
2628
- [ ] :metal: renders as expected with Bedrock CSS (`?bedrock`)
27-
- [ ] :wheelchair: analyzed via [axe](https://www.deque.com/axe/) and evaluated using VoiceOver
2829
- [ ] :guardsman: includes new unit tests
29-
- [ ] :memo: tested in Chrome, Firefox, Safari, Edge, and IE11
30+
- [ ] :wheelchair: tested for [WCAG 2.1](https://www.w3.org/TR/WCAG21) AA compliance
31+
- [ ] :memo: tested in Chrome, Firefox, Safari, and Edge

0 commit comments

Comments
 (0)