Make the non-native-English PR/issue guidance concrete#544
Merged
dennisdoomen merged 2 commits intoJul 26, 2026
Conversation
The existing rule was one abstract line and easy to ignore in practice (see PR Fallout-build#528's description). Break it into checkable rules -- one idea per sentence, no idioms, define jargon on first use, gloss cross-references -- and add two anti-pattern examples pulled from a real PR description. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Terms like shim, sentinel, and canonical type show up often in PRs and issues but are never defined anywhere, making descriptions hard to follow for non-native English readers. Add a short glossary and link to it from issue-and-pr-style.md's non-native-English guidance. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Collaborator
|
lets take it for a test ride aye? |
ChrisonSimtian
approved these changes
Jul 26, 2026
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
2 participants
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.
PR #528's description is a good example of what the existing "write for non-native English readers" rule was meant to prevent, but the rule was one abstract line and easy to skip.
What changed
issue-and-pr-style.mdinto checkable guidance: one idea per sentence, no idioms/figurative language, define jargon on first use, gloss cross-references, prefer short words.conventions.md, linked from the rule above.