Add a glossary of repo jargon to conventions.md - #543
Closed
dennisdoomen wants to merge 1 commit into
Closed
Conversation
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
Author
|
Combining into #544 per feedback. |
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
1 participant
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.
Follow-up to the PR #528 discussion: PR descriptions lean on undefined jargon (
shim,sentinel,canonical type, etc.), which is hard to follow for non-native English readers.What changed
Part of the non-native-English readability effort.