go.mondoo.com/cnquery@v0.0.0-20231005093811-59568235f6ea/.github/actions/spelling/advice.md (about)

     1  <!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
     2  <details><summary>If the flagged items are false positives</summary>
     3  
     4  If items relate to a ...
     5  
     6  - binary file (or some other file you wouldn't want to check at all).
     7  
     8    Please add a file path to the `excludes.txt` file matching the containing file.
     9  
    10    File paths are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
    11  
    12    `^` 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).
    13  
    14  - well-formed pattern.
    15  
    16    If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
    17    try adding it to the `patterns.txt` file.
    18  
    19    Patterns are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
    20  
    21    Note that patterns can't match multiline strings.
    22  
    23  </details>