Updates to triaging guide: Issue prioritization and high-level triage workflow#1308
Updates to triaging guide: Issue prioritization and high-level triage workflow#1308asteiker wants to merge 42 commits into
Conversation
|
I will automatically update this comment whenever this PR is modified
|
|
Nice work! 🤩 |
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
|
@asteiker just in case you didn't see them, many of my comments are hidden because I did too many 🫣 |
saberbrasher
left a comment
There was a problem hiding this comment.
Awesome work on this @asteiker and @mfisher87 !! I have a few comments/ questions, but you two definitely did the heavy lifting.
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
|
@mfisher87 @saberbrasher I have moved this out of draft and is ready for your re-review! @Sherwin-14 there were a few minor changes made to the workflow diagram so I wanted to make sure you have an opportunity to review as well. It looks like there are conflicts that will need to be resolved but maybe this can be done once it's ready to merge. |
saberbrasher
left a comment
There was a problem hiding this comment.
A quick initial review! This is looking great, Amy!
| **We hope that this guide will empower anyone to contribute to issue triaging, and address a common question for contributors: "I'm interested in working on the highest priority issues that will solve important problems facing the `earthaccess` community. Where do I begin?"** | ||
|
|
||
| When labeling an issue, choose the label(s) that best describes the issue. Using labels consistently and accurately ensures that issues are trackable and searchable. | ||
| See the [Issue grooming](#issue-grooming) section below for details on how to identify and browse prioritized issues via the [`earthaccess` GitHub Project](https://github.com/orgs/earthaccess-dev/projects/1). |
There was a problem hiding this comment.
I suggest we maybe call this section "Issue prioritization" to be in line with the title of the page.
There was a problem hiding this comment.
Right now this section sort of blends in/ gets lost with all the other text. I wonder if putting it in a nice little info box could add a visual separation, and then adding something like:
"Want to start working quickly?" before the "see this section for details...." content might draw attention to it.
|
|
||
| ## Working issues | ||
|
|
||
| - [Assign](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users) the issue to the implementer. |
There was a problem hiding this comment.
Doesn't this happen automatically for this library? I don't remember ever having to assign myself. I suppose the person creating the issue may not be the person who solves it, but in that case, there would be a PR created by someone else (which would be assigned to the PR creator).
There was a problem hiding this comment.
I am not aware of the Issue assignments happening automatically. Are you thinking about a workflow where a PR is submitted, and then the related Issue is linked? Is that where you would expect the Issue to get automatically assigned based on the PR assignment? Otherwise how would this be auto-assigned if the issue was in work?
There was a problem hiding this comment.
oops, ignore this comment! I was getting the issue assignment functionality here in GitHub mixed up with another tool.
Co-authored-by: Saber Brasher <134096880+saberbrasher@users.noreply.github.com>
Co-authored-by: Saber Brasher <134096880+saberbrasher@users.noreply.github.com>
Co-authored-by: Saber Brasher <134096880+saberbrasher@users.noreply.github.com>
Co-authored-by: Saber Brasher <134096880+saberbrasher@users.noreply.github.com>
Description
Resolves #1070 and based on recent discussions at the Collab cafe with @saberbrasher on incorporating prioritization best practices, GitHub project management, and overall triaging workflow into the Triaging Guide.
This guide now begins with an issue lifecycle overview, and describes those lifecycle steps in detail with a focus on issue triaging and prioritization. This guide is also meant to help contributors understand our prioritization process and criteria, and how to find prioritized issues in our GitHub project.
"Ready for review" checklist
Merge checklist
closes #1)CHANGELOG.mdupdatedREADME.mdupdatedpre-commit.ci autofixif pre-commit is failing)📚 Documentation preview 📚: https://earthaccess--1308.org.readthedocs.build/en/1308/