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.
Heavily inspired by https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md
Fixes #98
I wanted to keep the docs minimal to start and grow them organically based on need rather than including everything I can think of and making it overwhelming for people, but I'm unsure where to strike the balance. There's a bunch of good stuff from Bevy's contribution guide that I cut that I would love to add over time based on feedback from other contributors.
I think the biggest question right now is how to handle issue tags. Bevy has a comprehensive system similar to the Rust project's issue tags. I want to ensure we have the tags we need to keep things organized, but I'm not sure that we need anything that robust; we don't have nearly as much traffic. I'm leaning towards starting with a minimal set of tags inspired by bevy. The stuff about status (e.g. S-controversial) and difficulty and how those relate to reviews seem like they could be pretty useful for onboarding new reviewers and contributors.
I'll make sure to add all the right tags and check that all the links are working before merging this.
Long term I want to update this or create companion docs to describe various roles like "Triage", "Review", "Merge", etc which may entail rewriting decent chunks of this.