From 83869acd5da4eef515410d105447f1af6480464a Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Fri, 19 May 2023 11:26:49 -0400 Subject: [PATCH 1/2] Update README to provide more details on how this action works. --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 936aeac..e749d22 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,19 @@ # Accessibility-alt-text-bot -An action to remind users to add alt text to their issue descriptions and comments. +This action supports accessible content sharing on GitHub by leaving an automated reminder whenever an image is shared on a GitHub Issue or Pull request without meaningful alternative text (alt text). +Alternative text helps convey the context of the image to those who use assistive technologies such as a screen reader and removes accessibility barriers. + +For guidance on setting alternative text, see [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images). + +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. + +**Note**: Ordinarily, setting `alt=""` will mark images as decorative. However, GitHub currently 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: @@ -26,22 +33,21 @@ jobs: uses: github/accessibility-alt-text-bot ``` -## Action stability +### Action stability To ensure you stay on a stable version of this action consider locking the action to a specific version. -``` +```yml uses: github/accessibility-alt-text-bot@v1.0.0 -``` +``` Replace the ref value with any commit hash. -## License +## License This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE.txt) for the full terms. - -## Maintainers +## Maintainers See [CODEOWNERS](.github/CODEOWNERS). From 25c0f3ce3fbf923af4d288c766bc59039443314d Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Fri, 19 May 2023 11:36:23 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e749d22..0ff6b2c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ Alternative text helps convey the context of the image to those who use assistiv For guidance on setting alternative text, see [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images). -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. +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: + +Screenshot of an automated actions comment on a GitHub issue that says, 'Uh oh! @monalisa, the image you shared is missing helpful alt text...' and contains instructions for setting alt text **Note**: Ordinarily, setting `alt=""` will mark images as decorative. However, GitHub currently renders all images as a link. To avoid rendering links with no names, we recommend always setting alt text on images in GitHub.