Accessibility Issue Template
An issue template for reporting accessibility (a11y) problems with WCAG criterion, assistive technology details, and impact on users with disabilities.
Detailed Explanation
Accessibility Issue Template
Accessibility issues affect real users who rely on assistive technologies. A specialized template captures the unique context needed: which WCAG criterion is violated, which assistive technology is affected, and what the expected accessible behavior should be.
Template Structure
name: "Accessibility Issue"
description: "Report an accessibility barrier"
title: "[a11y]: "
labels: ["accessibility", "bug"]
body:
- type: markdown
attributes:
value: |
Thank you for helping improve accessibility. Your report
helps ensure our product works for everyone.
- type: dropdown
id: wcag_criterion
attributes:
label: "WCAG Criterion"
description: "Which accessibility guideline is not met?"
options:
- "1.1.1 Non-text Content"
- "1.3.1 Info and Relationships"
- "1.4.3 Contrast (Minimum)"
- "1.4.11 Non-text Contrast"
- "2.1.1 Keyboard"
- "2.4.3 Focus Order"
- "2.4.7 Focus Visible"
- "3.3.2 Labels or Instructions"
- "4.1.2 Name, Role, Value"
- "Other / Not sure"
validations:
required: true
- type: dropdown
id: assistive_tech
attributes:
label: "Assistive Technology"
description: "Which assistive technology is affected?"
multiple: true
options:
- "Screen reader (NVDA)"
- "Screen reader (JAWS)"
- "Screen reader (VoiceOver)"
- "Screen magnifier"
- "Keyboard only"
- "Switch control"
- "Voice control"
- "None / Visual inspection"
validations:
required: true
- type: textarea
id: description
attributes:
label: "Issue Description"
description: "Describe the accessibility barrier"
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: "Expected Accessible Behavior"
description: "How should this work for users with assistive technology?"
validations:
required: true
- type: dropdown
id: impact
attributes:
label: "User Impact"
options:
- "Blocker - Cannot complete task"
- "Major - Task very difficult"
- "Minor - Inconvenient but usable"
validations:
required: true
WCAG Criterion Field
Including common WCAG success criteria as dropdown options educates reporters about accessibility standards while collecting structured data for compliance tracking.
Multiple Assistive Technologies
The multiple: true attribute on the assistive technology dropdown allows reporters to indicate all affected tools, as issues often affect multiple assistive technologies.
Compliance Tracking
Teams can use the WCAG criterion data to generate compliance reports and track progress toward WCAG 2.1 AA conformance across their product.
Use Case
Web applications, design systems, and organizations committed to WCAG compliance that need to systematically track and resolve accessibility barriers reported by users and auditors.