earthaccess icon indicating copy to clipboard operation
earthaccess copied to clipboard

We don't have documentation about "triaging"

Open mfisher87 opened this issue 1 year ago • 5 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. https://github.com/nsidc/earthaccess/labels/hackathon is from pasting 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.

mfisher87 avatar Jul 09 '24 15:07 mfisher87

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 avatar Jul 10 '24 01:07 mfisher87

@mfisher87 Hey I am thinking of working on this one, any specific opinions on this one?

Sherwin-14 avatar Sep 26 '24 17:09 Sherwin-14

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 avatar Sep 26 '24 19:09 mfisher87

@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

Sherwin-14 avatar Sep 28 '24 15:09 Sherwin-14

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.

mfisher87 avatar Oct 04 '24 14:10 mfisher87

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.

I am thinking of coming up with the first draft. Then we can discuss further on prioritization labels as well as the flowcharts.

Sherwin-14 avatar Nov 03 '24 11:11 Sherwin-14

@mfisher87 Hey Matt, I have been working on this one for a while now and I have run into some issues with mermaid, so should I make a PR with whatever I have done uptill now(barring the mermaid part) or should I complete the chart as well and then make the PR? Which option would you deem as plausible former or the latter one?

Sherwin-14 avatar Nov 28 '24 14:11 Sherwin-14

Feel free to open a PR in draft mode at any time if you'd like feedback or to enable other contributors to follow your progress! I'd appreciate if you'd include your work-in-progress mermaid code so we can take a look and see if we can help :)

mfisher87 avatar Nov 29 '24 22:11 mfisher87

Closing this out, as it was merged under #901

asteiker avatar Aug 19 '25 17:08 asteiker