Final editing pass, and publish contributing guide #1605
Merged
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
…ntribute Easier on the navigation header.
Now that Contributing Guide has been shortened to Contribute, this is no longer needed. Still keeping the text-align: center tho.
This is a last resort to make sure stuff stays reasonable widths apart.
This way we can de-duplicate the information to one place.
This could still use some substantive editing regarding *what* constitutes a useful test.
It reads better this way.
Technically the Bevy Organization projects you can contribute to expands past the game engine, primarily the website, so I feel it is a good idea to make this distinction since a game engine is wildly different to a website for what you can contribute to it. Also maybe some substantive editing regarding difference of Organization and Foundation may be needed to clarify things.
Since the callout version is a singular reference and unlikely to be re-used, I simply made it a masked link to reduce the false positive warnings.
Add some light humor to the sentence
People already mistakenly report websites issues to the Bevy repository sometimes, so it doesn't hurt to clarify this.
It's more readable this way compared to the tall text wall.
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Miles Silberling-Cook <NthTensor@users.noreply.github.com>
Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com>
This reverts commit 3cc6bf9. No longer appropriate for this PR.
BD103
reviewed
Aug 20, 2024
content/learn/contribute/helping-out/reviewing-pull-requests.md
Outdated
Show resolved
Hide resolved
content/learn/contribute/helping-out/reviewing-pull-requests.md
Outdated
Show resolved
Hide resolved
content/learn/contribute/project-information/bevy-organization.md
Outdated
Show resolved
Hide resolved
content/learn/contribute/project-information/bevy-organization.md
Outdated
Show resolved
Hide resolved
BD103
reviewed
Aug 20, 2024
Comment on lines
+22
to
+27
| [[links]] | ||
| title = "Contributing Guide" | ||
| url = "/learn/contribute/introduction" | ||
| image = "/assets/book.svg" | ||
| image_alt = "A slanted book" | ||
| description = "Learn how to best contribute to the Bevy Project." |
There was a problem hiding this comment.
Right now this is 4th in the list on the "Learn" page. Should it be moved down, or is it fine where it is?
There was a problem hiding this comment.
I'm unsure myself, I figured either Alice, or Cart, or really anyone, would chime in with a preference, or if no one had a preference then we'd let it be how it is currently.
|
Overall I'm super happy with these changes! Once the non-blocking changes are addressed, I'm going to give my approval. Thanks for following through on this :) |
Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com>
NthTensor
approved these changes
Aug 21, 2024
NthTensor
added
S-Ready-For-Final-Review
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
Closes #1146
Do a last-pass edit of, and publish, the Contributing Guide.
Solution
Do a heavy scrutiny copy editing run across the whole of the Contributing Guide (this means stuff has changed from prior PRs necessitating reviews here and now), then remove it from public draft, and deprecate the old
CONTRIBUTING.md. Also slightly modifies CSS to accommodate the navigation bar becoming crammed.Notes
Note
I think some more editing could be done, but that'd be best for [a] follow-up[s]. Particularly what I mentioned in 9e127bb
Note
Also, deprecates bevy CONTRIBUTING.md, bevy/docs The Bevy Organization,and bevy/docs Release Checklist. Should have a follow-up PR in
bevyto deprecate them properly.Warning
Please review with great scrutiny since this is the final pass before the public gets to see it.