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

ci: Spellcheck GH action #50

Merged
merged 4 commits into from
Nov 16, 2022
Merged

ci: Spellcheck GH action #50

merged 4 commits into from
Nov 16, 2022

Conversation

serdardalgic
Copy link
Contributor

@serdardalgic serdardalgic commented Nov 14, 2022

This PR adds two checkers:

  • spellchecker
  • checker for non-inclusive language.

The .wordlist-en-custom.txt file is generated after the output of the spellchecker.

Please review.

Related to #42. Please merge it after merging #49

@serdardalgic serdardalgic marked this pull request as draft November 14, 2022 12:42
@serdardalgic serdardalgic changed the base branch from main to conventional-commit-checker-GH-action November 14, 2022 12:42
@serdardalgic serdardalgic marked this pull request as ready for review November 14, 2022 15:15
drsm79
drsm79 previously approved these changes Nov 14, 2022
@serdardalgic serdardalgic force-pushed the conventional-commit-checker-GH-action branch from 38e5308 to 5745edd Compare November 15, 2022 12:15
Base automatically changed from conventional-commit-checker-GH-action to main November 15, 2022 13:45
IOPS
InstanceType
Postgres
biganimal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should Biganimal be capitalized?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, spellchecker is not clever enough to distinguish when a word appears. This biganimal is coming from

terraform {
  required_providers {
    biganimal = {
      source  = "biganimal"
      version = "0.3.1"
    }
  }
}

And, with the current implementation, if we use biganimal in, let's say, README.md, it will accept it. 🤷 not the best implementation, but I don't have any suggestions for fixing it. If you have, I'd love to hear.

And I've only added the words that the spellchecker was complaining about. Biganimal wasn't one of them.

nstott
nstott previously approved these changes Nov 15, 2022
Copy link
Contributor

@nstott nstott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Member

@mbiagetti mbiagetti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@serdardalgic serdardalgic merged commit 4562316 into main Nov 16, 2022
@serdardalgic serdardalgic deleted the spellcheck-GH-action branch November 16, 2022 11:13
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.

4 participants