Conversation
Collaborator
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.
What does this PR do?
Adds the one-paragraph error-message convention to
CONTRIBUTING.mdas a bullet under Code Style, directly after the existing Error handling bullet (line 343 on currentmain): every user-facing error message names the actual cause and the remediation step, never the proximate symptom.The text is lifted verbatim from #112005, which carries it as the deliverable following @teknium1's close comment on #111128 ("welcome as its own small docs PR"). Docs-only: one bullet, no code, no sweep — the individual message fixes stay on the per-issue path (#105150, #99831, #70908 and friends cite this convention once it lands).
Relationship to #111630
#111630 (open since earlier today) adds its own version of this convention as a standalone section further down the file, inside a PR that also carries four code fixes and tests. Per the one-cluster-per-PR rule quoted in the #111128 close note, this PR stays strictly docs-only and keeps the bullet form/placement the issue specifies. If the standalone-section form is preferred, I'm happy to rebase onto it or drop this — maintainer's call.
Closes #112005.