Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Joyce Zhu <[email protected]>
  • Loading branch information
kendallgassner and JoyceZhu authored Jan 24, 2025
1 parent 8dad2f8 commit 7d49d9c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,16 @@ Replace the ref value with any commit hash.
### Experimental: Adding a custom linting configuration
If you would like to include more linting rules from the [markdownlint](https://github.com/DavidAnson/markdownlint) or [markdownlint-github](https://github.com/github/markdownlint-github) rulesets pass a `config` object to the `github/accessibility-alt-text-bot` action.
If you would like to include more linting rules from the [markdownlint](https://github.com/DavidAnson/markdownlint) or [markdownlint-github](https://github.com/github/markdownlint-github) rulesets, pass a `config` object to the `github/accessibility-alt-text-bot` action.


⚠ Consider adding new rules sparingly, as excessive rules could make the bot too noisy and make it too hard for users to fixes.
⚠ Consider adding new rules sparingly, as excessive rules could make the bot too noisy and overwhelm users.

⚠ This feature is marked 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.
⚠ 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.

```yml
steps:
- name: Check alt text #change this step to use the
- name: Check alt text
uses: github/[email protected]
with:
config: |
Expand Down

0 comments on commit 7d49d9c

Please sign in to comment.