Skip to content

Commit 14c64a5

Browse files
Add experimental custom linting configuration section
more information
1 parent 1a2ce92 commit 14c64a5

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,14 @@ This makes sure you stay on a stable version of this action.
6767
6868
Replace the ref value with any commit hash.
6969
70-
### Adding a custom linting configuration
70+
### Experimental: Adding a custom linting configuration
7171
72-
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.
72+
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.
73+
74+
75+
⚠ Consider adding new rules sparingly, as excessive rules could make the bot too noisy and make it too hard for users to fixes.
76+
77+
⚠ 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.
7378

7479
```yml
7580
steps:

0 commit comments

Comments
 (0)