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

Add a CONTRIBUTING book to replace the scattered resources about how to contribute #1146

Open
5 tasks
alice-i-cecile opened this issue May 2, 2024 · 3 comments
Labels
A-Meta C-Enhancement New feature or request S-Ready-For-Implementation The core questions are answered: just add code

Comments

@alice-i-cecile
Copy link
Member

Motivation

The existing https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md is generally far too long for a single page, and painful to read as a long block of markdown.

We also have scattered information throughout the project about how things are run:

That are somehow even less discoverable. Most of these were deemed too irrelevant and distracting to put into the main CONTRIBUTING.md (valid!), but that means they serve no practical purpose to 99% of contributors who have no idea that they exist.

We have a solution for "structured, long-form content with multiple pages that we want high visibility for": books hosted on the bevyengine.org domain.

Solution

  • Create a new book (using all of the existing styling and tooling of the existing quick start guide and in-depth book) in this repo. Make it hidden for now.
  • Copy all of the existing content into that book.
  • Do a brief cleanup pass.
  • Make it visible under a new top-level Contribute header beside "Foundation".
  • Replace the main CONTRIBUTING.md in each repo with a link to the appropriate section of the book.
@alice-i-cecile alice-i-cecile added C-Enhancement New feature or request A-Meta labels May 2, 2024
@cart
Copy link
Member

cart commented May 4, 2024

I'm on board for this! Only first-impression note is that we might want to avoid use of the word "Book" in the final published result, just to avoid confusion/overlap with "The Bevy Book".

@TrialDragon
Copy link
Member

Regarding The Bevy Organization document, it'd probably work best as having it's info moved to the community people page of the site; already has same basic information, just needs to be expanded upon with details. If so, then that can probably be spun out into it's own issue separate of the Contributor's Guide (name that seems to have picked up traction in Discord so far).

@BD103
Copy link
Member

BD103 commented May 4, 2024

For future reference, this is being worked on by the Contributor's Guide working group on Discord with an in-progress design doc on hackmd.io.

@alice-i-cecile alice-i-cecile added the S-Ready-For-Implementation The core questions are answered: just add code label May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Meta C-Enhancement New feature or request S-Ready-For-Implementation The core questions are answered: just add code
Projects
None yet
Development

No branches or pull requests

4 participants