Disable natural language check in super-linter workflow #592
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
lint
workflow runs super-linter, which enables theterminology
rule for the textlint linter. Per the super-lintertextlint 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 theterminology
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 ofwebsite
andrepo
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!