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

Contributor's Guide: Create "Using Github Issues" #1178

Merged
merged 15 commits into from
May 24, 2024

Conversation

BD103
Copy link
Member

@BD103 BD103 commented May 17, 2024

Part of #1146. This covers both a guide on when to create issues, as well as a more general-purpose triage reference.

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.
@BD103 BD103 marked this pull request as ready for review May 20, 2024 23:20
Copy link
Member

@alice-i-cecile alice-i-cecile left a 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.

@BD103
Copy link
Member Author

BD103 commented May 22, 2024

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?

@BD103 BD103 requested a review from alice-i-cecile May 22, 2024 12:52
Copy link
Member

@alice-i-cecile alice-i-cecile left a 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>
@BD103
Copy link
Member Author

BD103 commented May 22, 2024

I'm writing one quick section on Github Discussions, then this is good to go!

Edit: Done!

BD103 and others added 2 commits May 23, 2024 22:54
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: ramirezmike
@BD103 BD103 added S-Ready-For-Final-Review Ready for a maintainer to consider for merging and removed S-Needs-Review labels May 24, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue May 24, 2024
Merged via the queue into bevyengine:main with commit c5c3c74 May 24, 2024
10 checks passed
@BD103 BD103 deleted the using-github-issues branch May 24, 2024 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Contributing-Guide C-Content S-Ready-For-Final-Review Ready for a maintainer to consider for merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants