Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create README.md #1

Open
wants to merge 1 commit into
base: prerelease
Choose a base branch
from
Open

Create README.md #1

wants to merge 1 commit into from

Conversation

jsoref
Copy link
Member

@jsoref jsoref commented Aug 1, 2024

No description provided.

@@ -0,0 +1,5 @@
Teh quick brown foox jumps over the lazy dog.

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error

Teh is not a recognized word. (unrecognized-spelling)
@@ -0,0 +1,5 @@
Teh quick brown foox jumps over the lazy dog.

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error

foox is not a recognized word. (unrecognized-spelling)

When the wind blows, the cradle will rock.

Hoow many times times must things go this way?

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error

Hoow is not a recognized word. (unrecognized-spelling)

When the wind blows, the cradle will rock.

Hoow many times times must things go this way?

Check failure

Code scanning / check-spelling

Forbidden Pattern Error

times times matches a line_forbidden.patterns entry: "\\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\\s\\g{-1}\\s". (forbidden-pattern)
Copy link

github-actions bot commented Aug 1, 2024

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (3)

foox
Hoow
Teh

To accept these unrecognized words as correct, you could run the following commands

... in a clone of the [email protected]:check-spelling/reimagined-chainsaw.git repository
on the jsoref-patch-1 branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/8b63ad52f62f9c28efb41d0ac54e24d794d33b05/apply.pl' |
perl - 'https://github.com/check-spelling/reimagined-chainsaw/actions/runs/10199117805/attempts/1'

OR

To have the bot accept them for you, comment in the PR quoting the following line:
@check-spelling-bot apply updates.

Forbidden patterns 🙅 (1)

In order to address this, you could change the content to not match the forbidden patterns (comments before forbidden patterns may help explain why they're forbidden), add patterns for acceptable instances, or adjust the forbidden patterns themselves.

These forbidden patterns matched content:

In English, duplicated words are generally mistakes

There are a few exceptions (e.g. "that that").
If the highlighted doubled word pair is in:

  • code, write a pattern to mask it.
  • prose, have someone read the English before you dismiss this error.
\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s
Errors (1)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors Count
❌ forbidden-pattern 1

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

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

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

🚂 If you're seeing this message and your PR is from a branch that doesn't have check-spelling,
please merge to your PR's base branch to get the version configured for your repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant