[Merged by Bors] - Comprehensive CONTRIBUTING.md

[alice-i-cecile]

RENDERED

Improves #910. As discussed in #1309, we'll need to synchronize content between this and the Bevy website in some way (and clean up the .github file perhaps?).

I think doing it as a root-directory file is nicer for discovery, but that's a conversation I'm interested in having.

This document is intended to be helpful to beginners to open source and Bevy, and captures what I've learned about our informal practices and values.

Reviewers: I'm particularly interested in:

• opinions on the items What we're trying to build, where I discuss some of the project's high-level values and goals
• more relevant details on the bevy subcrates for Getting oriented
• useful tricks and best practices that I missed
• better guidance on how to contribute to the Bevy book from @cart <3

[alice-i-cecile]

I still need to add the advice on Contributing Docs from the official book but I'm not really sure how to do so elegantly.

Perhaps it belongs in docs folders in bevy and bevy-website with links in this file?

EDIT: Figured it: these are specialized instructions for the bevy-website and belong in a CONTRIBUTING.md file there instead.

[alice-i-cecile]

Once this is merged, I think it could work nicely as a dedicated blog post for discoverability and promotion to broader communities :)

[alice-i-cecile]

as a noob to git and rust, it appears that on windows, line endings are changed when a git repo is cloned, when i tried to run cargo fmt on my first pr, git marked all files as changed and i couldn’t find why, i think it should be mentioned somewhere perhaps..

From @TheLeonsver1 <3

Does anyone have concrete guidance on this issue and how to fix it? We should mention it quickly but I'm not convinced I know enough to give good advice.

[MinerSebas]

Two things that should probably also be mentioned.

• When adding a new example, also add it to the ./examples/README.md File.
• When creating a new crate, add in the Author field of the Cargo.toml a "Bevy Contributors <bevyengine@gmail.com>" entry and add the new crate to the ./tools./publish.sh File.

[colepoirier]

Unfortunately this was all I was able to get through tonight, more to come tomorrow :)

[giusdp]

Thanks for pointing me to this PR @alice-i-cecile !
Being a newcomer I can give you my noob experience to this new doc, but it might be a lot of text.

The Getting Oriented section is a nice addition, the first time I started exploring Bevy was overwhelming especially opening the main repo and seeing all those crates! In the future the number of repos will probably increase as well and for the next newcomers it will be even worse, having this section that gives an overview on the organization is amazing. I also believe that an ARCHITECTURE.md doc (#910 (comment)) that explains more in depth the bevy repo is necessary (or at least I'd love it!).

The "How we work together" and "Contributing your ideas" sections:
To be honest I kinda got confused here. From existing docs I know that to contribute I have to fork, do my stuff, run some commands to check for warnings and make a PR. Here this is only explained in the last section, with the title implying it's only for the case of adding novelty features (at least it's how I understood it). The "How we work together" section talks about the contributing process lifecycle, and explains how it works contributing small changes and complex changes. I thought this was the most important section to start working, I probably would have just jumped ahead and read a subsection describing the area where I want to contribute and stop there, using as reference "How we work together". I think many people might not read "Contributing your ideas" because it seems something advanced.

Last thing, it's more for myself, I re-read docs a lot of times so a table of contents might be nice?

Overall it was great! Way better than the existing doc, and best of all it was reassuring! 😄

[mockersf]

There is now a built in ToC in all markdown files rendered on GitHub!

But as this file probably won't evolve that much, we could still have one more visible. No preference for me, just wanted to mention this new GitHub feature

[alice-i-cecile]

Anyone want to help me fix broken links? >.> I'm a little sick of it right now and I'm not sure what it needs.

[NathanSWard]

Anyone want to help me fix broken links? >.> I'm a little sick of it right now and I'm not sure what it needs.

I can help out tomorrow :)

[cart]

Just expanded, updated (to account for recent renames and process changes), and tweaked a bunch of stuff. Feel free to discuss any / all of these changes. @alice-i-cecile lemme know if/when you're cool with merging this.

[alice-i-cecile]

@cart those changes look great to me. I'm good to merge now, then we can migrate it over to the website later <3

[msvbg]

Suggested change

	Making a game engine is a huge project and facilitating collaboration is a lot of work. At the moment @cart is our only paid contributor, so [go sponsor him!](https://github.com/sponsors/cart).
	Making a game engine is a huge project and facilitating collaboration is a lot of work. At the moment @cart is our only paid contributor, so [go sponsor him!](https://github.com/sponsors/cart)

[cart]

bors r+

[bors]

Pull request successfully merged into main.

Build succeeded:

• build-android
• build (nightly, ubuntu-latest)
• build (stable, macos-latest)
• build (stable, ubuntu-latest)
• build (stable, windows-latest)
• build-wasm (nightly, ubuntu-latest)
• build-wasm (stable, ubuntu-latest)
• check-doc
• check-markdown-links
• check-missing-examples-in-docs
• check-unused-dependencies
• ci
• markdownlint
• run-examples