Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/github/accessibility-alt-text-bot
An action to remind users to add alt text on Issues, Pull Requests, and Discussions
https://github.com/github/accessibility-alt-text-bot
accessibility actions
Last synced: 2 days ago
JSON representation
An action to remind users to add alt text on Issues, Pull Requests, and Discussions
- Host: GitHub
- URL: https://github.com/github/accessibility-alt-text-bot
- Owner: github
- License: mit
- Created: 2023-04-24T17:26:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-02T15:40:47.000Z (about 1 month ago)
- Last Synced: 2025-01-04T11:46:27.026Z (9 days ago)
- Topics: accessibility, actions
- Language: JavaScript
- Homepage:
- Size: 8.6 MB
- Stars: 78
- Watchers: 7
- Forks: 15
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# Accessibility-alt-text-bot
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, read [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images).
## Why you may need this action
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:
> [!TIP]
> Normally, setting `alt=""` marks images as decorative. But GitHub renders all images as a link. To avoid rendering links with no names, we recommend always setting alt text on images in GitHub.
## How to add this action to your repo
Copy this workflow into any repo you want the `accessibility-alt-text-bot` to run in:
```yml
name: Accessibility-alt-text-bot
on:
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: write
pull-requests: write
discussions: write
jobs:
accessibility_alt_text_bot:
name: Check alt text is set on issue or pull requests
if: ${{ !endsWith(github.actor, '[bot]') }}
runs-on: ubuntu-latest
steps:
- name: Get action 'github/accessibility-alt-text-bot'
uses: github/[email protected] # Set to latest
```
### Pin the action's version for stability
We recommend you pin the action to a specific version.
This makes sure you stay on a stable version of this action.
```yml
uses: github/[email protected]
```
Replace the ref value with any commit hash.
## License
This project is licensed under the terms of the MIT open source license.
Please read [the MIT license file](./LICENSE.txt) for the full terms.
## Maintainers
See [CODEOWNERS](.github/CODEOWNERS).
## Support
TODO: Be explicit about support expectations.
## Acknowledgement
Please read our [Contributing Guide](./CONTRIBUTING.md) for more information.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Katie Foster
🤔 ️️️️♿️
Kendall Gassner
💻 ️️️️♿️ 📖 🚇
Kate Higa
💻 ️️️️♿️ 📖 🚇
HonkingGoose
📖
JoshuaKGoldberg
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!