How to maximise badge accessibility?
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- github, markdown
- Domain
- accessibility, documentation
Research direction
Start by reviewing the repository's badge usage and the WCAG 1.4.5 Images of Text guidance linked in the issue. Evaluate the listed alternatives with screen-reader testing, then document an explicit decision for static badges and suitable alt-text or plain-text treatment.
Written by the indexing model from the issue text.
Description
Badges - the SVG images we use to communicate repository health - are images of text, which are discouraged by WCAG 1.4.5 Images of Text since plain text is more accessible. But they are the only way to display dynamic content in a GitHub-flavoured-Markdown. We are probably forced to use these, with appropriate alt-text to maximise accessibility.
The more tricky question is what should be done with the static badges (e.g. 'this repository uses ASV' or whatever). We use these since so that they are consistent with the dynamic badges, making for a more visually readable list of repository health markers. But for 'non-visual' reading (screen readers) they are LESS readable. We should make an explicit decision on these, possibly based on testing with a screen reader:
- Replace with plain text?
- Keep as a badge, with the best alt-text we can manage?
- Discourage users of screen readers from attempting to read the health section?
Again, the most important thing is to consider this, even if measured decision is to leave it.
- Dominant language
- Python
- Stars
- 3
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SciTools/.github
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
🚴♀️ peloton
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
All issues in SciTools/.github
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100