Skip to content

Commit 88f6524

Browse files
committed
add some initial readme guidance for accessibility violations
1 parent 5139d3f commit 88f6524

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Readme.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,21 @@ Videos can be added using the `<Video />` component and referencing a path to th
176176
<Video src="/path/to/video.mp4" />
177177
```
178178

179+
## Accessibility testing
180+
181+
We run automated accessibility testing on pages affected by a pull request in both light and dark mode. Some common violations and their solutions are listed here:
182+
183+
```
184+
Element has insufficient color contrast
185+
```
186+
[Text colors must have a contrast ratio of 4.5:1 against their background](https://www.w3.org/TR/WCAG22/#contrast-minimum). Avoid adding custom styling to text; our design system should ensure that accessible color combinations are in use.
187+
188+
```
189+
Heading order invalid
190+
```
191+
Headings should be properly nested. This means, for example, an `<h3>` element must be nested beneath an `<h2>` element on the page, an `<h4>` must be nested beneath an `<h3>` and so on. Use [markdown syntax to create your headings](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#headings).
192+
193+
179194
## Debug client-side code with browser developer tools
180195

181196
### Prerequisites

0 commit comments

Comments
 (0)