PowerToys/.github/actions/spell-check/advice.md
Josh Soref 02de31b7c0
Update check-spelling (#14873)
* Updating advice

Copying 18764e6cbb/.github/actions/spelling/advice.md

* Update exclusions

* sort exclusions
* exclude .filters files based on updated engine suggestions
* exclude src/modules/previewpane/UnitTests-MarkdownPreviewHandler/HelperFiles/MarkdownWithHTMLImageTag.txt based on updated engine suggestions

* Upgrade check-spelling to v0.0.20-alpha3

Updates patterns to better handle guids
closes #14854

Adds a couple of other patterns:
* publicKeyToken
* @sha256:
* std::wregex

Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
2021-12-12 11:42:04 -08:00

1.1 KiB

If the flagged items do not appear to be text

If items relate to a ...

  • well-formed pattern.

    If you can write a pattern that would match it, try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

  • binary file.

    Please add a file path to the excludes.txt file matching the containing file.

    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 README.md (on whichever branch you're using).