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 contributing doc for eyre #99

Merged
merged 4 commits into from
Nov 7, 2023
Merged

Add contributing doc for eyre #99

merged 4 commits into from
Nov 7, 2023

Conversation

yaahc
Copy link
Collaborator

@yaahc yaahc commented Aug 12, 2023

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.

Copy link
Contributor

@pksunkara pksunkara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good on first look.

Approving assuming that label and PR examples are moved away from bevy.

Copy link
Contributor

@ten3roberts ten3roberts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fantastic.

Really like the clear focus on the fact that anyone is free to contribute and you don't need to be an unsafe Rust zealot to do so.

The part on documentation and constructive criticism is also splendid.

I assume the specific labels will be changed to ones specific to eyre in time.

@ten3roberts
Copy link
Contributor

Additionally, just confirming that I am absolutely fine to @mention in PRs. Sometimes you may miss a message due to the volume of mails, so the explicit mention always catches my eye.

@yaahc yaahc merged commit 12479e9 into master Nov 7, 2023
29 checks passed
@yaahc yaahc deleted the community-hype branch November 7, 2023 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance Status
3 participants