View on GitHub


Documentation for check-spelling

advice Examples

Advice is a file that is inserted raw into GitHub comments (or potentially in the log if the commit results in stale expect items and no unexpected items).

Here are some examples:

<details><summary>If you see a bunch of garbage and it relates to a binary-ish string</summary>

Please add a file path to the `excludes.txt` file instead of just accepting the garbage.

File paths are Perl 5 Regular Expressions - you can [test]( yours before committing to verify it will match your files.

`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude []( (on whichever branch you're using).

Advice about garbage

As of v0.0.18, the file can be named instead of advice.txt.

FAQ | Showcase | Event descriptions | Configuration information | Known Issues | Possible features | Deprecations | Release notes | Helpful scripts