-
-
Couldn't load subscription status.
- Fork 4.2k
Closed
Labels
A-MetaAbout the project itselfAbout the project itselfC-DocsAn addition or correction to our documentationAn addition or correction to our documentation
Description
How can Bevy's documentation be improved?
In this section, we talk a lot about the mechanical aspects of how a PR might be put up for adoption and be adopted, but not very much about how to actually get an adopted PR merged. It seems like folks could use a little more guidance here.
I think it might be good to explicitly spell out that
- Driving a PR forward to mergeville will be collaborative process and a time investment after the adoption PR is opened.
- The PR needs to be made mergeable "mechanically" but the adopter also needs to address existing feedback on the old PR and any new feedback along the way.
- The adopter should communicate how they have addressed existing feedback or issues.
- The adopter should add a PR description that "stands alone," reflects the current state of the PR, but also references the old PR.
- A PR being put up for adoption doesn't necessarily mean that there is consensus that the PR should be merged.
Maybe this is all just too much information though, and something like the automated "new contributor" messages for PRs that look like they are adoptions could help.
Side note: Maybe this section should be moved below the "contributing code" section.
Anyone have other thoughts/ideas?
alice-i-cecile and ChristopherBiscardi
Metadata
Metadata
Assignees
Labels
A-MetaAbout the project itselfAbout the project itselfC-DocsAn addition or correction to our documentationAn addition or correction to our documentation