From 2f157b4facf6b5975987d299d7ec58340c071f4e Mon Sep 17 00:00:00 2001 From: Keenan Zhou Date: Tue, 7 Jul 2026 13:47:51 -0400 Subject: [PATCH 1/3] Document alt-text plugin in Plugins section --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 052bf17..16562aa 100644 --- a/README.md +++ b/README.md @@ -180,7 +180,18 @@ The a11y scanner leverages GitHub Copilot coding agent, which can be configured ## Plugins -See the [plugin docs](https://github.com/github/accessibility-scanner/tree/main/PLUGINS.md) for more information +See the [plugin docs](https://github.com/github/accessibility-scanner/tree/main/PLUGINS.md) for more information, including how to load plugins published to npm. + +### 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: + +```yaml +scans: | + ["axe", {"name": "alt-text-scan", "package": "@github/accessibility-scanner-alt-text-plugin", "version": "1.0.0"}] +``` + +See the [plugin README](https://github.com/github/accessibility-scanner-alt-text-plugin#getting-started) for the full rule list and setup. --- From 92e55abd365370bb8c537681d816ca897843ebae Mon Sep 17 00:00:00 2001 From: Keenan Zhou Date: Tue, 7 Jul 2026 14:00:50 -0400 Subject: [PATCH 2/3] Make section less dense/more readable --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 16562aa..efffe9c 100644 --- a/README.md +++ b/README.md @@ -184,7 +184,7 @@ See the [plugin docs](https://github.com/github/accessibility-scanner/tree/main/ ### 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: +The [Alt Text Plugin](https://github.com/github/accessibility-scanner-alt-text-plugin) is a first-party scanner plugin published to npm as [`@github/accessibility-scanner-alt-text-plugin`](https://www.npmjs.com/package/@github/accessibility-scanner-alt-text-plugin). It flags low-quality `alt` text that can pass Axe's `image-alt` rule, including vague or generic descriptions, raw filenames, repeated text, and placeholder values. The scanner installs the package at runtime; to enable it, add the plugin to the `scans` input using its package name: ```yaml scans: | From 752cdcb90a8b4f1790f1ea87ab2b18d97712a380 Mon Sep 17 00:00:00 2001 From: Keenan Zhou Date: Wed, 8 Jul 2026 13:49:25 -0700 Subject: [PATCH 3/3] Wording changes Co-authored-by: Joyce Zhu --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index efffe9c..8caf4f9 100644 --- a/README.md +++ b/README.md @@ -182,7 +182,7 @@ The a11y scanner leverages GitHub Copilot coding agent, which can be configured See the [plugin docs](https://github.com/github/accessibility-scanner/tree/main/PLUGINS.md) for more information, including how to load plugins published to npm. -### Alt-Text Plugin +### Alt Text Plugin The [Alt Text Plugin](https://github.com/github/accessibility-scanner-alt-text-plugin) is a first-party scanner plugin published to npm as [`@github/accessibility-scanner-alt-text-plugin`](https://www.npmjs.com/package/@github/accessibility-scanner-alt-text-plugin). It flags low-quality `alt` text that can pass Axe's `image-alt` rule, including vague or generic descriptions, raw filenames, repeated text, and placeholder values. The scanner installs the package at runtime; to enable it, add the plugin to the `scans` input using its package name: @@ -191,7 +191,7 @@ scans: | ["axe", {"name": "alt-text-scan", "package": "@github/accessibility-scanner-alt-text-plugin", "version": "1.0.0"}] ``` -See the [plugin README](https://github.com/github/accessibility-scanner-alt-text-plugin#getting-started) for the full rule list and setup. +See the [plugin README](https://github.com/github/accessibility-scanner-alt-text-plugin#getting-started) for the current release version, full rule list, and setup instructions. ---