Skip to content

Commit 5a8737d

Browse files
authored
Merge pull request #355 from wunderio/feature/awesome-pr-template
Improve PR template. Add accessibility testing information.
2 parents 793d771 + 686cb1a commit 5a8737d

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

.github/pull_request_template.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
1-
Link to ticket: JIRA-123
1+
## Link to ticket:
22

3-
Changes proposed in this PR:
4-
- change a
5-
- change b
3+
[Add link to ticket]
64

7-
How to test:
8-
1. do this
9-
1. then do that
10-
1. you should now see xyz
5+
## Link to feature environment:
116

12-
Link to feature environment:
13-
<add silta url here>
7+
[Add link to feature environment]
8+
9+
## Changes proposed in this PR:
10+
11+
[Explain what was done and why. You can also add screenshots here if it helps.]
12+
13+
## How to test:
14+
15+
1. Do this
16+
2. Then do that
17+
18+
## Best practices:
19+
20+
<details>
21+
<summary><h3>Accessibility:</h3></summary>
22+
<p>
23+
This project must support WCAG accessibility level AA <em>(edit this according to the requirements of your project)</em>. To ensure this standard is met, remember to:
24+
25+
- Perform automated checks using a tool such as Wave or SiteImprove.
26+
- Test keyboard navigation: are all parts of the UI navigable using only the keyboard? Is the tab order logical? Can popups, menus etc be dismissed with the escape key?
27+
- Test responsiveness, scaling and text reflow.
28+
- Make sure no accessibility issues exist on either desktop or mobile views.
29+
- If you have time, test with a screen reader such as VoiceOver (macOS), NVDA (Windows), or Orca (Linux).
30+
31+
Use the [Accessibility Testing Cheat Sheet](https://intra.wunder.io/info/accessibility-group/accessibility-testing-cheat-sheet) for information on how to run these tests.
32+
</p>
33+
</details>

0 commit comments

Comments
 (0)