Document alt-text plugin in Plugins section#247
Open
kzhou314 wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.
Documents the first-party Alt-Text plugin in the README’s Plugins section so users can discover it and configure it via the scans input.
Changes:
- Expands the Plugins section with a clearer link to plugin docs and npm-loading guidance
- Adds a dedicated “Alt-Text Plugin” subsection describing what it flags and how to enable it
- Provides a YAML configuration example referencing the published npm package
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds documentation for the Alt-Text plugin and an example configuration snippet |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Low
| ### Alt-Text Plugin | ||
|
|
||
| The [Alt-Text Plugin](https://github.com/github/accessibility-scanner-alt-text-plugin) is a first-party plugin, published to npm as [`@github/accessibility-scanner-alt-text-plugin`](https://www.npmjs.com/package/@github/accessibility-scanner-alt-text-plugin), that flags low-quality `alt` text — vague or generic wording, raw filenames, and repeated or placeholder text — beyond what Axe's `image-alt` rule catches. The scanner installs it for you at runtime; just add it to the `scans` input as an object with its `package` name: | ||
|
|
JoyceZhu
reviewed
Jul 8, 2026
JoyceZhu
reviewed
Jul 8, 2026
Co-authored-by: Joyce Zhu <joycezhu@github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.