Skip to content

Commit

Permalink
Add experimental custom linting configuration section
Browse files Browse the repository at this point in the history
more information
  • Loading branch information
kendallgassner authored Jan 9, 2025
1 parent 1a2ce92 commit 14c64a5
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,14 @@ This makes sure you stay on a stable version of this action.
Replace the ref value with any commit hash.
### Adding a custom linting configuration
### 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.

⚠ 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.

```yml
steps:
Expand Down

0 comments on commit 14c64a5

Please sign in to comment.