Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Slightly better message when contributor modifies examples template #9372

Merged
merged 2 commits into from
Aug 7, 2023

Conversation

rparrett
Copy link
Contributor

@rparrett rparrett commented Aug 6, 2023

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

@rparrett rparrett added C-Docs An addition or correction to our documentation A-Build-System Related to build systems or continuous integration C-Examples An addition or correction to our examples labels Aug 6, 2023
@mockersf mockersf added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Aug 6, 2023
Co-authored-by: Nicola Papale <[email protected]>
@rparrett rparrett removed the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Aug 7, 2023
@rparrett
Copy link
Contributor Author

rparrett commented Aug 7, 2023

Please re-review. The new message changed significantly for the better based on feedback.

@nicopap nicopap added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Aug 7, 2023
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Aug 7, 2023
Merged via the queue into bevyengine:main with commit 9e8de2a Aug 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation C-Examples An addition or correction to our examples S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants