We don't have documentation about "triaging"
mfisher87 opened this issue · 6 comments
Should we use this term? It's just the term GitHub uses for the role, but we can call it whatever we want. I think the main thing that needs to be explained is labeling issues. What do each of the labels mean and when do we use them? How do you share a link to a label in GitHub Markdown (e.g.
hackathon
https://github.com/nsidc/earthaccess/labels/hackathon)? When to use "close issue as not planned"? What is a discussion vs an issue and when should we migrate between them (e.g. discussions for feature requests, issues for bugs?)? etc.
Stumbled on a great example which uses mermaid to draw a triage flowchart!!
https://github.com/vitejs/vite/blob/main/CONTRIBUTING.md#issue-triaging-workflow
@mfisher87 Hey I am thinking of working on this one, any specific opinions on this one?
Awesome, thanks Sherwin! I would love a flowchart diagram. In answering the questions in the description of the issue, I think it would be OK to leave some questions partially answered. For example, there are some labels like hackathon, good first issue, help wanted, etc. that we're really confident we want people to use and will stay around for a long time. But there are other labels, like "python", that I could imagine being removed or renamed to e.g. "impact/code". We can skip the ones we're not sure about for now, and perhaps once the PR is open others will share their ideas.
@mfisher87 I had a doubt regarding the flowchart. Should I come up with a flowchart different than the one you linked above in the 2nd comment. If yes, how can I decide or how would I know which are the hierarchies and what things are going to be listed under it? I have little idea about this one
I think we can use their flowchart as a base. There are some places I would make things more "Friendly". E.g. instead of "Close and ask to follow template", I'd suggest "Change to draft and ask to follow template".
We currently don't have prioritization labels, so we could omit that part. Or maybe we should add the prioritization labels and start using them! What do you think?
If you're comfortable doing a first draft and opening a PR, that could help start some conversation with the community that will guide us towards a solution.