bevyengine / bevy-website

The source files for the official Bevy website
https://bevyengine.org
MIT License
190 stars 321 forks source link

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

Open alice-i-cecile opened 2 months ago

alice-i-cecile commented 2 months ago

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

cart commented 2 months ago

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 commented 2 months ago

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 commented 1 month ago

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.