Skip to content

Commit 0d90109

Browse files
authored
docs: add accessibility guidance
Add accessibility guidance, an accessibility issue template, and a PR checklist for open-source accessibility practices.
1 parent e46459a commit 0d90109

5 files changed

Lines changed: 97 additions & 0 deletions

File tree

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Accessibility issue
2+
description: Report a barrier in the CLI, reports, docs, API docs, or Web UI.
3+
title: "[Accessibility]: "
4+
labels: ["accessibility"]
5+
body:
6+
- type: textarea
7+
id: barrier
8+
attributes:
9+
label: Accessibility barrier
10+
description: What was difficult or impossible to use?
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: surface
15+
attributes:
16+
label: Surface
17+
description: CLI command, report, API page, Web UI screen, or documentation page.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: environment
22+
attributes:
23+
label: Environment
24+
description: Browser, terminal, operating system, screen reader, keyboard-only use, or other setup.
25+
- type: textarea
26+
id: sample
27+
attributes:
28+
label: Safe sample
29+
description: Minimal synthetic sample input or output. Do not include private ad copy or customer data.
30+
- type: textarea
31+
id: expected
32+
attributes:
33+
label: Expected behavior
34+
description: What would make this accessible?

.github/pull_request_template.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Summary
2+
3+
-
4+
5+
## Checks
6+
7+
- [ ] I ran relevant tests or documented why not.
8+
- [ ] I added or updated tests/eval rows for behavior changes.
9+
- [ ] I preserved decision-support and legal-boundary language.
10+
- [ ] I avoided adding private data, secrets, or raw real ad submissions.
11+
- [ ] I checked keyboard navigation, labels, visible focus, and color-independent status in UI changes.
12+
- [ ] I kept CLI and report output understandable without relying on color alone.
13+
- [ ] I updated docs if the user-facing behavior changed.

ACCESSIBILITY.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Accessibility
2+
3+
AdLint includes a CLI, FastAPI service, reports, documentation, and a local Web
4+
UI. Accessibility work in this repo focuses on making policy review usable for
5+
keyboard-only users, screen reader users, low-vision users, and users who rely on
6+
structured output.
7+
8+
## What we aim for
9+
10+
- CLI output remains useful without color and supports JSON for automation.
11+
- Markdown reports use clear headings, tables, and descriptive links.
12+
- The local Web UI supports keyboard navigation and visible focus states.
13+
- Form fields have labels, descriptions, and useful error messages.
14+
- Review decisions do not depend on color alone.
15+
- Screenshots and docs include meaningful alt text.
16+
- Motion or loading states avoid creating barriers.
17+
18+
## Reporting accessibility issues
19+
20+
Please open an accessibility issue if you find:
21+
22+
- unlabeled form controls or confusing focus order
23+
- color-only severity or decision indicators
24+
- reports that are hard to navigate with assistive technology
25+
- CLI output that cannot be understood without color
26+
- screenshots or docs without useful text alternatives
27+
28+
Include the command, page, browser, terminal, operating system, assistive
29+
technology, and sample input when relevant. Do not include private ad copy,
30+
customer data, credentials, or raw real submissions.
31+
32+
## Contribution expectations
33+
34+
UI changes should include a keyboard pass, visible-focus check, and
35+
color-independent review of severity/status indicators. CLI/report changes
36+
should preserve structured output and readable text output.

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,19 @@ AdLint should remain privacy-conscious:
7474
- Do not claim legal compliance, guaranteed platform approval, or definitive statutory determinations.
7575
- Keep local model features as decision support unless benchmarked evidence proves otherwise.
7676
77+
## Accessibility expectations
78+
79+
- Keep CLI output understandable without color alone.
80+
- Preserve JSON output for users who need structured or automated review.
81+
- Label Web UI form controls and keep keyboard focus visible.
82+
- Do not communicate severity, status, or risk only through color.
83+
- Add useful alt text for screenshots and diagrams.
84+
7785
## Pull request checklist
7886
7987
- [ ] I ran relevant tests or documented why not.
8088
- [ ] I added/updated tests or eval rows for behavior changes.
8189
- [ ] I preserved decision-support and legal-boundary language.
8290
- [ ] I avoided adding private data, secrets, or raw real ad submissions.
91+
- [ ] I checked relevant accessibility expectations from [ACCESSIBILITY.md](ACCESSIBILITY.md).
8392
- [ ] I updated docs if the user-facing behavior changed.

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,6 +579,11 @@ High-value contribution areas:
579579
- Safer rewrite-quality evaluation.
580580
- Docs, examples, screenshots, and launch polish.
581581

582+
## Accessibility
583+
584+
Accessibility expectations for the CLI, reports, docs, and local Web UI are in
585+
[ACCESSIBILITY.md](ACCESSIBILITY.md).
586+
582587
## Related docs
583588

584589
- `docs/open_source_goal.md`

0 commit comments

Comments
 (0)