Skip to content

Commit ddcee29

Browse files
committed
πŸ“ Document a11y tests in README; drop references to gone make targets
1 parent 462707f commit ddcee29

1 file changed

Lines changed: 13 additions & 4 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,19 @@ Make sure the services are running.
8888
```shell
8989
# Run all tests
9090
make test
91-
# Run only unit/integration tests
92-
make testci
93-
# Run only end-to-end tests
94-
make testui
91+
# Run only the end-to-end tests, which include the accessibility checks
92+
pytest froide/tests/live
93+
```
94+
95+
### Accessibility tests
96+
97+
The end-to-end tests check the pages they visit with [axe-core](https://github.com/dequelabs/axe-core). Findings are compared against the snapshots in `froide/tests/live/snapshots/`, so a test fails when a page gains a problem it didn't have before β€” existing findings are accepted debt.
98+
99+
```shell
100+
# Record the current findings as the new baseline, then review the diff and commit
101+
pytest froide/tests/live --force-regen
102+
# Show the full axe report for every finding, recorded or not
103+
pytest froide/tests/live --a11y-strict
95104
```
96105

97106
### Development tooling

0 commit comments

Comments
Β (0)