uabrc / uabrc/uabrc.github.io

a11y: Update pull request template with accessibility checks

Open Beginner friendly
#1,145 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

fix: accessibility ♿
Dominant language
Python
Stars
24
Forks
15
Avg merge
10d 3h
Merged PRs (30d)
1

Description

Refine items in PR template. Start rigorously checking PR template when proposing and reviewing changes.

## Accessibility

### Images

- [ ] [has alt text](https://www.wcag.com/blog/good-alt-text-bad-alt-text-making-your-content-perceivable/)
- [ ] has transcription of text content
- [ ] [has sufficient contrast ratio](https://webaim.org/resources/contrastchecker/)
- [ ] numeric labels in keyboard nav order
- [ ] description of items with numeric labels in keyboard nav order

### Terminology

- [ ] abbreviations defined where introduced
- [ ] technical terms and jargon defined where introduced
- [ ] add new technical terms, jargon, and abbreviations to glossary
- [ ] [branding terms](https://docs.rc.uab.edu/contributing/contributor_guide#terminology) defined where introduced

## Style Checklist

### References

- [ ] crosslinked from my content to other relevant content
- [ ] crosslinked from other relevant content to my content
- [ ] crosslinked to glossary terms

### Site Navigation

- [ ] `mkdocs.yml` redirects for header and page name changes

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the repository's pull request template and compare it with the requested Accessibility, Terminology, References, and Site Navigation checklist items. Check the referenced mkdocs.yml redirect guidance as needed. Done means the template includes the requested checks and links, with no unrelated changes.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.