docs: add Vale rules suggesting alternatives to animal-derived idioms#21374
Open
stuckvgn wants to merge 1 commit intogithub:mainfrom
Open
docs: add Vale rules suggesting alternatives to animal-derived idioms#21374stuckvgn wants to merge 1 commit intogithub:mainfrom
stuckvgn wants to merge 1 commit intogithub:mainfrom
Conversation
Introduce suggestion-level substitution rules that flag common animal-derived phrases and offer clearer alternatives.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Adds a small set of Vale substitution rules that suggest more precise alternatives to common animal-derived idioms in documentation.
For example:
The suggested alternatives are often more descriptive and clearer for non-native English speakers, while also avoiding phrases that casually reference animal harm.
Details
Two rule files added under
docs/codeql/vale-styles/Speciesism/:All rules are set to
suggestionlevel — they only surface alternatives during writing and won't affect CI or block any workflows.Context
A growing number of documentation projects are adding speciesism-aware language rules to their Vale configurations (webpack.js.org, Elastic, Datadog, and others), following the same trajectory as the shift from master/slave → primary/replica and whitelist/blacklist → allowlist/blocklist.
The CodeQL docs already enable
Microsoft.Gender— this extends that same attention to inclusive language.References: Peer-reviewed paper on speciesist language
Changes
docs/codeql/vale-styles/Speciesism/AnimalIdioms.ymldocs/codeql/vale-styles/Speciesism/AnimalMetaphors.ymldocs/codeql/.vale.inito includeSpeciesisminBasedOnStyles