-
Notifications
You must be signed in to change notification settings - Fork 309
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
Contributor's Guide: Create "Using Github Issues" #1178
Conversation
The previous, more procedural, way of determing docs root sections did not take into consideration possible docs sections outside of `/learn/*`. I would've done a better procedural way, but the lack of while loops in Tera threw a wrench in that plan, so for now this is the best I can do without further blocking progress on the contributing guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good content! I think this page is in a bit of a weird place: it's talking to two different audiences. The first is "I'm a random user who wants to file an issue" and the second is "I want to do or understand triage". The intro and "When to File an Issue" feel like they should be lumped into a "Filing Issues" doc, while the rest belongs in a "Bevy's Triage Process" doc.
In the second doc, we should also make it very clear that we hand out triage rights like candy, and to just ask if you have any interest.
I've split up the document into a page on Github Issues and a page on triage. Tell me what you think! Does "Using Github Issues" now need more content, or does it serve its purpose? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the split! I've left advice for you on the Triage section in a comment :)
We should have a section in "Using Github Issues" on when to open a Discussion instead. That should flesh it out nicely.
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Edit: Done! |
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: ramirezmike
Part of #1146. This covers both a guide on when to create issues, as well as a more general-purpose triage reference.