Initial draft for triaging #901

Sherwin-14 · 2024-12-15T06:54:19Z

This is the initial draft for the triaging document(#754). The pre-commit check is failing because of the use of format argument which seems like a necessity for rendering the doc, more on this here.

📚 Documentation preview 📚: https://earthaccess--901.org.readthedocs.build/en/901/

github-actions · 2024-12-15T06:54:31Z

👈 Launch a binder notebook on this branch for commit 7b7f1aa

I will automatically update this comment whenever this PR is modified

👈 Launch a binder notebook on this branch for commit 4145cfe

👈 Launch a binder notebook on this branch for commit a7a182c

👈 Launch a binder notebook on this branch for commit 9e876f3

👈 Launch a binder notebook on this branch for commit aa815ff

👈 Launch a binder notebook on this branch for commit b04d16f

👈 Launch a binder notebook on this branch for commit 827d79c

👈 Launch a binder notebook on this branch for commit a9c8ea8

👈 Launch a binder notebook on this branch for commit 70f2f42

👈 Launch a binder notebook on this branch for commit 70edb3d

👈 Launch a binder notebook on this branch for commit 0b939b6

👈 Launch a binder notebook on this branch for commit e53370f

👈 Launch a binder notebook on this branch for commit ed81270

👈 Launch a binder notebook on this branch for commit 5ce45af

👈 Launch a binder notebook on this branch for commit f41f79c

👈 Launch a binder notebook on this branch for commit 6c4df6b

👈 Launch a binder notebook on this branch for commit a2029a5

👈 Launch a binder notebook on this branch for commit a953c0e

👈 Launch a binder notebook on this branch for commit c89cb13

👈 Launch a binder notebook on this branch for commit cabf675

👈 Launch a binder notebook on this branch for commit 393df4a

👈 Launch a binder notebook on this branch for commit cf51bad

mfisher87 · 2024-12-15T18:21:58Z

Nice work! Will look more closely this week.

Looks like there's a tradeoff to be considered here to fix linting with --unsafe: https://github.com/pre-commit/pre-commit-hooks#check-yaml

asteiker · 2024-12-16T17:49:46Z

I'm wondering if some updates may be needed based on the recently closed #760 ? If it would be helpful for me to review and update accordingly, I'd be happy to help.

mfisher87 · 2024-12-16T18:43:41Z

@asteiker that would be super helpful!!

mfisher87 · 2024-12-30T17:13:07Z

@asteiker OK to assign this PR to you?

mfisher87

🙌 Amazing work! Sorry about the number of suggestions here -- we re-organized labels in #760 to be more self-describing, and I think that helps make this document more clear!

CHANGELOG.md

docs/contributing/triaging.md

mfisher87 · 2025-01-12T16:11:42Z

@asteiker can you also take a look?

Co-authored-by: Matt Fisher <[email protected]>

mkdocs.yml

Co-authored-by: Matt Fisher <[email protected]>

Sherwin-14 · 2025-01-13T14:44:21Z

@mfisher87 Hey Matt, what about PR triaging workflows? Wouldn't they also be included in the triaging doc?

mfisher87 · 2025-01-13T15:59:24Z

I'm not sure exactly what you mean here; are you thinking about PR reviews?

Sherwin-14 · 2025-01-14T11:23:15Z

I'm not sure exactly what you mean here; are you thinking about PR reviews?

Yeah PR reviews workflow(I confused it with PR triaging), there is a flowchart for that as well in the repo you linked, should we add that as well to our triaging guide?

mfisher87 · 2025-01-14T18:16:34Z

I think it's a great idea! But I would also like to keep this PR focused and get it merged without too much delay. What do you think about dealing with that in another PR?

mfisher87 · 2025-01-14T18:17:48Z

@Sherwin-14 I'd like to wait to review until the ReadTheDocs build is working again. Do you feel comfortable fixing it? Details here: #901 (comment)

Sherwin-14 · 2025-01-15T15:48:02Z

I think it's a great idea! But I would also like to keep this PR focused and get it merged without too much delay. What do you think about dealing with that in another PR?

Sounds good to me :). I also have added the mermaid dependency.

mfisher87

In a rush, just leaving comments :)

mkdocs.yml

mfisher87 · 2025-01-15T16:52:46Z

docs/contributing/triaging.md

+- **needs: decision**: We're struggling to decide what to do and the decision committee needs to help.
+- **needs: feedback**:  Use this label for issues where feedback is requested from the team or our community.
+- **needs: help**: Use this label for issues where additional help or contributions are needed.
+


I'd like to add back the "good first issue" label, perhaps alone in a "Special labels" section? That is one that triagers should be especially aware of!

mfisher87 · 2025-01-15T16:56:43Z

docs/contributing/triaging.md

+  start == YES ==> dupe{Is duplicate?}
+  dupe == YES ==> close2[Close and point to duplicate]
+  dupe == NO ==> repro{Has proper reproduction?}
+  repro == NO ==> close3[Label: 'needs reproduction' bot will auto close if no update has been made in 3 days]


bot will auto close if no update has been made in 3 days

I think this isn't true. We have one automation for autoclosing issues, but I believe it's broken: https://github.com/nsidc/earthaccess/blob/main/.github/workflows/issue-manager.yml

We should be careful about fixing it: #895 & https://jacobtomlinson.dev/posts/2024/most-stale-bots-are-anti-user-and-anti-contributor-but-they-dont-have-to-be/

Hey, I did not made changes to the flowchart since we had discussed earlier, that flowchart will be reviewed. so that is why a lot of irrelevant info is still up there.

Ah, that makes sense, thanks for the context! I forgot 🙃

So how do we move forward from here? I know there might some specific suggestions that you may have in your mind. I think we can encompass all of those in a single review, so it becomes easier for me to add them to the PR :)

I think getting @asteiker 's eyes on this is probably the best way forward. Will you be at next week's hack day? Maybe we can work together to finalize the flowchart.

mfisher87 · 2025-01-15T16:57:50Z

docs/contributing/triaging.md

+  real == NO ==> intended{Is the intended behaviour?}
+  intended == YES ==> explain[Explain and close point to docs if needed]
+  intended == NO ==> open[Keep open for discussion Remove 'pending triage' label]
+  real == YES ==> real2["1. Remove 'pending triage' label 2. Add related feature label if applicable (e.g. 'feat: ssr') 3. Add priority and meta labels (see below)"]


mfisher87 · 2025-01-15T16:58:28Z

docs/contributing/triaging.md

+  maj == NO ==> p4[p4: important]
+  unusable == NO ==> workarounds{Are there workarounds for the bug?}
+  workarounds == NO ==> p3[p3: minor bug]
+  workarounds == YES ==> p2[p2: edge case has workaround]


We don't have priority levels yet to my knowledge. @asteiker what do you think?

Co-authored-by: Matt Fisher <[email protected]>

mfisher87 · 2025-01-21T18:11:46Z

docs/contributing/triaging.md

+
+### Special labels
+
+- **good-first-issue**: Use this label for issues that are suitable for new contributors. These issues are designed to be approachable and not overly complex, making them an ideal starting point for those looking to contribute to the project.


Suggested change

- **good-first-issue**: Use this label for issues that are suitable for new contributors. These issues are designed to be approachable and not overly complex, making them an ideal starting point for those looking to contribute to the project.

- **good first issue**: Use this label for issues that are suitable for new contributors. These issues are designed to be approachable and not overly complex, making them an ideal starting point for those looking to contribute to the project.

Sherwin-14 added 5 commits December 15, 2024 12:17

Added the first bits intoduction and labelling issues

85f565b

Added all the sections as provided in the issue description

f77fad7

Added issue pr workflow diagram

4b82dbf

Made some adjustments to the flowchart in the context of earthaccess

ae0e833

Initial triaging draft

8a2c4e7

Sherwin-14 force-pushed the triaging branch from 7b7f1aa to 4145cfe Compare December 15, 2024 06:58

Sherwin-14 changed the title ~~Triaging~~ initial draft for triaging Dec 15, 2024

Sherwin-14 changed the title ~~initial draft for triaging~~ Initial draft for triaging Dec 15, 2024

Removed extra spaces

a7a182c

Sherwin-14 force-pushed the triaging branch from 4145cfe to a7a182c Compare December 15, 2024 15:01

mfisher87 assigned asteiker Jan 12, 2025

mfisher87 requested changes Jan 12, 2025

View reviewed changes

Sherwin-14 and others added 11 commits January 12, 2025 22:33

replaced doc with guide

9e876f3

Co-authored-by: Matt Fisher <[email protected]>

added triaging guide

aa815ff

Co-authored-by: Matt Fisher <[email protected]>

fixed a typo and grammatical error (removed quite from essential)

b04d16f

Co-authored-by: Matt Fisher <[email protected]>

made changes to the labelling issues section

827d79c

Co-authored-by: Matt Fisher <[email protected]>

added prefixes to labels

a9c8ea8

Co-authored-by: Matt Fisher <[email protected]>

made a change to section "When to use this label"

70f2f42

Co-authored-by: Matt Fisher <[email protected]>

differentiating two sections by removing a keyword

70edb3d

Co-authored-by: Matt Fisher <[email protected]>

added description for section titled "When to Migrate"

0b939b6

Co-authored-by: Matt Fisher <[email protected]>

updated the part "migrating an issue to a discussion when"

e53370f

Co-authored-by: Matt Fisher <[email protected]>

added impact labels

ed81270

Co-authored-by: Matt Fisher <[email protected]>

replaced requests and feedback with needs labels

5ce45af

Co-authored-by: Matt Fisher <[email protected]>

mfisher87 reviewed Jan 12, 2025

View reviewed changes

mkdocs.yml Show resolved Hide resolved

Sherwin-14 and others added 4 commits January 13, 2025 20:07

expanded linking a label to github markdown

f41f79c

Co-authored-by: Matt Fisher <[email protected]>

removed tip

6c4df6b

Co-authored-by: Matt Fisher <[email protected]>

made changes to section "close issue as not planned"

a2029a5

Co-authored-by: Matt Fisher <[email protected]>

Changed section heading for "When to Use This Label?"

a953c0e

Co-authored-by: Matt Fisher <[email protected]>

Sherwin-14 added 2 commits January 14, 2025 16:37

refactored the labelling section removing special labels section

2e48778

Made all the changes as per the review

c89cb13

Sherwin-14 requested a review from mfisher87 January 14, 2025 16:53

added mkdocs-mermaid plugin to doc dependencies

cabf675

mfisher87 reviewed Jan 15, 2025

View reviewed changes

Sherwin-14 and others added 2 commits January 15, 2025 22:31

updated the name of the doc

393df4a

Co-authored-by: Matt Fisher <[email protected]>

added good first issue label back in special label section

cf51bad

mfisher87 reviewed Jan 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial draft for triaging #901

Initial draft for triaging #901

Sherwin-14 commented Dec 15, 2024 •

edited

Loading

github-actions bot commented Dec 15, 2024 •

edited

Loading

mfisher87 commented Dec 15, 2024 •

edited

Loading

asteiker commented Dec 16, 2024

mfisher87 commented Dec 16, 2024

mfisher87 commented Dec 30, 2024

mfisher87 left a comment

mfisher87 commented Jan 12, 2025

Sherwin-14 commented Jan 13, 2025

mfisher87 commented Jan 13, 2025

Sherwin-14 commented Jan 14, 2025

mfisher87 commented Jan 14, 2025

mfisher87 commented Jan 14, 2025

Sherwin-14 commented Jan 15, 2025 •

edited

Loading

mfisher87 left a comment

mfisher87 Jan 15, 2025

mfisher87 Jan 15, 2025

Sherwin-14 Jan 15, 2025

mfisher87 Jan 15, 2025 •

edited

Loading

Sherwin-14 Jan 16, 2025 •

edited

Loading

mfisher87 Jan 16, 2025

mfisher87 Jan 15, 2025

mfisher87 Jan 15, 2025

mfisher87 Jan 21, 2025


		### Special labels

		- good-first-issue: Use this label for issues that are suitable for new contributors. These issues are designed to be approachable and not overly complex, making them an ideal starting point for those looking to contribute to the project.

	- good-first-issue: Use this label for issues that are suitable for new contributors. These issues are designed to be approachable and not overly complex, making them an ideal starting point for those looking to contribute to the project.
	- good first issue: Use this label for issues that are suitable for new contributors. These issues are designed to be approachable and not overly complex, making them an ideal starting point for those looking to contribute to the project.

Initial draft for triaging #901

Are you sure you want to change the base?

Initial draft for triaging #901

Conversation

Sherwin-14 commented Dec 15, 2024 • edited Loading

github-actions bot commented Dec 15, 2024 • edited Loading

mfisher87 commented Dec 15, 2024 • edited Loading

asteiker commented Dec 16, 2024

mfisher87 commented Dec 16, 2024

mfisher87 commented Dec 30, 2024

mfisher87 left a comment

Choose a reason for hiding this comment

mfisher87 commented Jan 12, 2025

Sherwin-14 commented Jan 13, 2025

mfisher87 commented Jan 13, 2025

Sherwin-14 commented Jan 14, 2025

mfisher87 commented Jan 14, 2025

mfisher87 commented Jan 14, 2025

Sherwin-14 commented Jan 15, 2025 • edited Loading

mfisher87 left a comment

Choose a reason for hiding this comment

mfisher87 Jan 15, 2025

Choose a reason for hiding this comment

mfisher87 Jan 15, 2025

Choose a reason for hiding this comment

Sherwin-14 Jan 15, 2025

Choose a reason for hiding this comment

mfisher87 Jan 15, 2025 • edited Loading

Choose a reason for hiding this comment

Sherwin-14 Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

mfisher87 Jan 16, 2025

Choose a reason for hiding this comment

mfisher87 Jan 15, 2025

Choose a reason for hiding this comment

mfisher87 Jan 15, 2025

Choose a reason for hiding this comment

mfisher87 Jan 21, 2025

Choose a reason for hiding this comment

Sherwin-14 commented Dec 15, 2024 •

edited

Loading

github-actions bot commented Dec 15, 2024 •

edited

Loading

mfisher87 commented Dec 15, 2024 •

edited

Loading

Sherwin-14 commented Jan 15, 2025 •

edited

Loading

mfisher87 Jan 15, 2025 •

edited

Loading

Sherwin-14 Jan 16, 2025 •

edited

Loading