Slightly better message when contributor modifies examples template #9372
Conversation
This file contains 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
rparrett
added
C-Docs
mockersf
approved these changes
Aug 6, 2023
mockersf
added
the
S-Ready-For-Final-Review
nicopap
reviewed
Aug 7, 2023
Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>
rparrett
removed
the
S-Ready-For-Final-Review
|
Please re-review. The new message changed significantly for the better based on feedback. |
nicopap
approved these changes
Aug 7, 2023
nicopap
added
the
S-Ready-For-Final-Review
alice-i-cecile
approved these changes
Aug 7, 2023
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.
Objective
Provide a slightly better message when a contributor needs to update the generated example readme file for any number of reasons but hasn't added any examples.
This recently happened here: #9370 (comment)
The contributor modified the readme template and is being told that they added an example.
Solution
The advice given is still correct. Just change the message so that it's not accusing the contributor of adding an example.
It may be possible to instead add more specific messages instead if someone is motivated to do that.
edit: reworked this whole PR text