Repository files navigation

This action reminds users to add a meaningful alternative text to their images.Alternative text helps users who rely on tools like screen readers, and lowers accessibility barriers.

The action can check:

• Issue comments
• Issue descriptions
• Pull Request comments
• Pull Request descriptions
• Discussion comments
• Discussion descriptions

To learn how to write good alternative text, readAlternative text for images on Primer.

Images on GitHub default to using the filename as alt text.This action flags when the alt text has not been updated from the default:

Copy this workflow into any repo you want theaccessibility-alt-text-bot to run in:

name:Accessibility-alt-text-boton:issues:types:[opened, edited]pull_request:types:[opened, edited]issue_comment:types:[created, edited, deleted]discussion:types:[created, edited]discussion_comment:types:[created, edited, deleted]permissions:issues:writepull-requests:writediscussions:writejobs:accessibility_alt_text_bot:name:Check alt text is set on issue or pull requestsif:${{ !endsWith(github.actor, '[bot]') }}runs-on:ubuntu-lateststeps:      -name:Get action 'github/accessibility-alt-text-bot'uses:github/accessibility-alt-text-bot@v1.7.1# Set to latest

We recommend you pin the action to a specific version.This makes sure you stay on a stable version of this action.

uses:github/accessibility-alt-text-bot@v1.7.1

Replace the ref value with any commit hash.

If you would like to include more linting rules from themarkdownlint ormarkdownlint-github rulesets, pass aconfig object to thegithub/accessibility-alt-text-bot action.

⚠ Consider adding new rules sparingly, as excessive rules could make the bot too noisy and overwhelm users.

⚠ This feature is experimental and may be removed in the future. We acknowledge that some repositories may want to implement more accessibility checks and aim to evaluate how users this feature before making it generally available.

steps:      -name:Check alt textuses:github/accessibility-alt-text-bot@v1.7.1with:config:|            no-default-alt-text: true,            no-alt-text: true,            no-empty-alt-text: true,            no-generic-link-text: true,

This project is licensed under the terms of the MIT open source license.Please readthe MIT license file for the full terms.

SeeCODEOWNERS.

TODO: Be explicit about support expectations.

Please read ourContributing Guide for more information.

Thanks goes to these wonderful people (emoji key):

Katie Foster 🤔️️️️♿️

Kendall Gassner 💻️️️️♿️📖🚇

Kate Higa 💻️️️️♿️📖🚇

HonkingGoose 📖

JoshuaKGoldberg 💻

This project follows theall-contributors specification.Contributions of any kind welcome!