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

Disable natural language check in super-linter workflow #592

Merged
merged 7 commits into from
Sep 10, 2024

Conversation

jeancochrane
Copy link
Contributor

@jeancochrane jeancochrane commented Sep 10, 2024

The lint workflow runs super-linter, which enables the terminology rule for the textlint linter. Per the super-linter
textlint template
, this is actually the only rule that super-linter enables for textlint. Super-linter calls this the "natural language" check.

I find the terminology rule unhelpful, in that it mostly just fails CI for my PRs due to small nitpicks like the use of "website" instead of "site" or "repo" instead of "repository". See this failed workflow run for an example. If we were publishing docs that needed to adhere to a strict styleguide, I might find this helpful, but instead I think it just slows down our velocity without clarifying our writing very much. As such, this PR disables textlint, and therefore the terminology rule, in our super-linter config.

See the terminology rule code for the list of replacements that this PR will disable. There doesn't seem to be a page for these replacements in the docs, so reading the code is indeed the recommended way of browsing them.

See this workflow run for evidence of the Natural Language check not running, and the super-linter workflow passing in spite of the presence of website and repo in the README.

My opinion about the helpfulness of this change is weakly held, so I'm open to pushback if either of you feel strongly that we should keep the natural language check!

@jeancochrane jeancochrane force-pushed the jeancochrane/disable-natural-language-check branch from 0c5efda to 71f307c Compare September 10, 2024 16:24
@jeancochrane jeancochrane marked this pull request as ready for review September 10, 2024 16:42
@jeancochrane jeancochrane requested a review from a team as a code owner September 10, 2024 16:42
@jeancochrane jeancochrane changed the title Disable natural language check in superlinter workflow Disable natural language check in super-linter workflow Sep 10, 2024
Copy link
Member

@dfsnow dfsnow left a comment

Choose a reason for hiding this comment

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

I'm fine with this and find myself annoyed with the same spelling nitpicks. Let's nix it.

@jeancochrane jeancochrane merged commit b93c545 into master Sep 10, 2024
7 checks passed
@jeancochrane jeancochrane deleted the jeancochrane/disable-natural-language-check branch September 10, 2024 17:07
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.

2 participants