From 3da689364cfde042666cf9ee77fab9af4444cdc6 Mon Sep 17 00:00:00 2001 From: Vihas Makwana Date: Sat, 28 Dec 2024 19:26:26 +0530 Subject: [PATCH 1/7] chore: diagram defining different states for issues --- issue-triaging.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/issue-triaging.md b/issue-triaging.md index b9a4f809e8d9..61c88c463225 100644 --- a/issue-triaging.md +++ b/issue-triaging.md @@ -71,3 +71,52 @@ triaged and is ready for work. If someone who is assigned to an issue is no long | `Sponsor Needed` | A new component has been proposed, but implementation is not ready to begin. This can be because a sponsor has not yet been decided, or because some details on the component still need to be decided. | | `Accepted Component` | A sponsor has elected to take on a component and implementation is ready to begin. | | `Vendor Specific Component` | This should be applied to any component proposal where the functionality for the component is particular to a vendor. | + +### State diagram + +Here is a diagram outlining the potential issue states and how issues move through different stages: + +```mermaid +flowchart TD + subgraph graph1["**needs-triage**"] + n1(["Needs Triage"]) + end + subgraph graph2["**waiting-for-codeowners**"] + n3["Waiting for Codeowners
to further validate the issue"] + end + subgraph graph3["**waiting-for-author**"] + n4["Waiting for author to provide more details"] + end + subgraph graph4["**help-wanted**"] + n8["Mark as help-wanted"] + end + n1 --> n2["Has good repro steps
and/or description?"] + n2 -- Yes --> n3 + n2 -- No/Need more details --> n4 + n2 -- Invalid configuration/alternative available --> n5(["Provide a detailed comment on the issue and close it."]) + n3 --> n6["Codeowner has time
to fix it?"] + n6 -- Yes --> n7["Valid issue and to be fixed
by a codeowner"] + n6 -- No --> n8 + n7 --> n9(["Issue closed once fix is merged"]) + n8 --> n9 + n4 -- Once enough detailsare available --> n2 + + n3@{ shape: rect} + n4@{ shape: rect} + n2@{ shape: diam} + n6@{ shape: diam} + n1:::Aqua + n3:::Ash + n4:::Ash + n8:::Ash + n2:::Ash + n2:::Peach + n5:::Rose + n6:::Peach + n7:::Ash + n9:::Rose + classDef Rose stroke-width:1px, stroke-dasharray:none, stroke:#FF5978, fill:#FFDFE5, color:#8E2236 + classDef Aqua stroke-width:1px, stroke-dasharray:none, stroke:#46EDC8, fill:#DEFFF8, color:#378E7A + classDef Peach stroke-width:1px, stroke-dasharray:none, stroke:#FBB35A, fill:#FFEFDB, color:#8F632D + classDef Ash stroke-width:1px, stroke-dasharray:none, stroke:#999999, fill:#EEEEEE, color:#000000 +``` \ No newline at end of file From b1d262b1380b3294fcaffa8b923b848b2715bec5 Mon Sep 17 00:00:00 2001 From: Vihas Makwana Date: Tue, 31 Dec 2024 19:11:45 +0530 Subject: [PATCH 2/7] update diagram --- issue-triaging.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/issue-triaging.md b/issue-triaging.md index 61c88c463225..ae1f9d1d6885 100644 --- a/issue-triaging.md +++ b/issue-triaging.md @@ -94,7 +94,8 @@ flowchart TD n2 -- Yes --> n3 n2 -- No/Need more details --> n4 n2 -- Invalid configuration/alternative available --> n5(["Provide a detailed comment on the issue and close it."]) - n3 --> n6["Codeowner has time
to fix it?"] + n3 -- Invalid Issue --> n5 + n3 -- Valid Issue --> n6["Codeowner has time
to fix it?"] n6 -- Yes --> n7["Valid issue and to be fixed
by a codeowner"] n6 -- No --> n8 n7 --> n9(["Issue closed once fix is merged"]) From 6a9efbb04538691ecac2719b7efa31e23c91bed2 Mon Sep 17 00:00:00 2001 From: Vihas Makwana <121151420+VihasMakwana@users.noreply.github.com> Date: Tue, 7 Jan 2025 14:39:36 +0530 Subject: [PATCH 3/7] Update issue-triaging.md Co-authored-by: Ziqi Zhao --- issue-triaging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/issue-triaging.md b/issue-triaging.md index ae1f9d1d6885..49804161a57a 100644 --- a/issue-triaging.md +++ b/issue-triaging.md @@ -100,7 +100,7 @@ flowchart TD n6 -- No --> n8 n7 --> n9(["Issue closed once fix is merged"]) n8 --> n9 - n4 -- Once enough detailsare available --> n2 + n4 -- Once enough details are available --> n2 n3@{ shape: rect} n4@{ shape: rect} From 15b23fcfa59dc39347b0332e5c6d0a7fc9e88b5a Mon Sep 17 00:00:00 2001 From: Vihas Makwana Date: Tue, 7 Jan 2025 14:47:14 +0530 Subject: [PATCH 4/7] chore: add subgraph --- issue-triaging.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/issue-triaging.md b/issue-triaging.md index 49804161a57a..79f38c8ac277 100644 --- a/issue-triaging.md +++ b/issue-triaging.md @@ -78,27 +78,30 @@ Here is a diagram outlining the potential issue states and how issues move throu ```mermaid flowchart TD - subgraph graph1["**needs-triage**"] + subgraph graph1["**needs-triage**"] n1(["Needs Triage"]) end - subgraph graph2["**waiting-for-codeowners**"] + subgraph graph2["**waiting-for-codeowners**"] n3["Waiting for Codeowners
to further validate the issue"] end - subgraph graph3["**waiting-for-author**"] + subgraph graph3["**waiting-for-author**"] n4["Waiting for author to provide more details"] end - subgraph graph4["**help-wanted**"] + subgraph graph4["**help-wanted**"] n8["Mark as help-wanted"] + end + subgraph graph5["**closed**"] + n9(["Close the issue and provide details as needed"]) end n1 --> n2["Has good repro steps
and/or description?"] n2 -- Yes --> n3 n2 -- No/Need more details --> n4 - n2 -- Invalid configuration/alternative available --> n5(["Provide a detailed comment on the issue and close it."]) - n3 -- Invalid Issue --> n5 + n2 -- Invalid configuration/alternative available --> n9 + n3 -- Invalid Issue --> n9 n3 -- Valid Issue --> n6["Codeowner has time
to fix it?"] n6 -- Yes --> n7["Valid issue and to be fixed
by a codeowner"] n6 -- No --> n8 - n7 --> n9(["Issue closed once fix is merged"]) + n7 --> n9 n8 --> n9 n4 -- Once enough details are available --> n2 From 8f66f5a37299642b81c570bf80eb03d491eec200 Mon Sep 17 00:00:00 2001 From: Vihas Makwana Date: Tue, 7 Jan 2025 15:40:14 +0530 Subject: [PATCH 5/7] redundant --- issue-triaging.md | 1 - 1 file changed, 1 deletion(-) diff --git a/issue-triaging.md b/issue-triaging.md index 79f38c8ac277..c797c33a345c 100644 --- a/issue-triaging.md +++ b/issue-triaging.md @@ -115,7 +115,6 @@ flowchart TD n8:::Ash n2:::Ash n2:::Peach - n5:::Rose n6:::Peach n7:::Ash n9:::Rose From 20afd550a2ad7dbd09db543475480801227b1a47 Mon Sep 17 00:00:00 2001 From: Vihas Makwana Date: Mon, 3 Feb 2025 16:45:47 +0530 Subject: [PATCH 6/7] address comments --- issue-triaging.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/issue-triaging.md b/issue-triaging.md index c797c33a345c..04abb2e8a2ad 100644 --- a/issue-triaging.md +++ b/issue-triaging.md @@ -78,9 +78,8 @@ Here is a diagram outlining the potential issue states and how issues move throu ```mermaid flowchart TD - subgraph graph1["**needs-triage**"] - n1(["Needs Triage"]) - end + n0(["New issue has been opened"]) --> n1 + n1(["Needs Triage"]) --> n2["Has good repro steps
and/or description?"] subgraph graph2["**waiting-for-codeowners**"] n3["Waiting for Codeowners
to further validate the issue"] end @@ -91,24 +90,30 @@ flowchart TD n8["Mark as help-wanted"] end subgraph graph5["**closed**"] - n9(["Close the issue and provide details as needed"]) + n10(["Close the issue and provide details as needed"]) end - n1 --> n2["Has good repro steps
and/or description?"] n2 -- Yes --> n3 n2 -- No/Need more details --> n4 - n2 -- Invalid configuration/alternative available --> n9 - n3 -- Invalid Issue --> n9 + n2 -- Invalid configuration/alternative available --> n10 + n3 -- Invalid Issue --> n10 n3 -- Valid Issue --> n6["Codeowner has time
to fix it?"] - n6 -- Yes --> n7["Valid issue and to be fixed
by a codeowner"] + n6 -- Assign it to codeowner --> n7["Issue in being worked upon"] n6 -- No --> n8 - n7 --> n9 - n8 --> n9 + n7 -- Once PR is merged --> n10 + n8 -- Wait for help from the community --> n9["Has someone volunteered?"] + n9 -- Yes --> n11["Assign it to the person"] + n12 -- Any activity? --> n9 + n9 -. Stale issue .-> n12["Issue in inactive"] + n11 --> n7 + n12 -- Closed automatically after 120 days due to lack of activity --> n10 n4 -- Once enough details are available --> n2 n3@{ shape: rect} n4@{ shape: rect} n2@{ shape: diam} n6@{ shape: diam} + n9@{ shape: diam} + n1:::Aqua n3:::Ash n4:::Ash @@ -117,7 +122,7 @@ flowchart TD n2:::Peach n6:::Peach n7:::Ash - n9:::Rose + n10:::Rose classDef Rose stroke-width:1px, stroke-dasharray:none, stroke:#FF5978, fill:#FFDFE5, color:#8E2236 classDef Aqua stroke-width:1px, stroke-dasharray:none, stroke:#46EDC8, fill:#DEFFF8, color:#378E7A classDef Peach stroke-width:1px, stroke-dasharray:none, stroke:#FBB35A, fill:#FFEFDB, color:#8F632D From 617a966d303a01f81b0fed6d6c3bf2ed61624f2c Mon Sep 17 00:00:00 2001 From: Vihas Makwana Date: Mon, 3 Feb 2025 19:11:49 +0530 Subject: [PATCH 7/7] more improvements --- issue-triaging.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/issue-triaging.md b/issue-triaging.md index 04abb2e8a2ad..32ccfe494659 100644 --- a/issue-triaging.md +++ b/issue-triaging.md @@ -87,7 +87,7 @@ flowchart TD n4["Waiting for author to provide more details"] end subgraph graph4["**help-wanted**"] - n8["Mark as help-wanted"] + n8["Waiting on community"] end subgraph graph5["**closed**"] n10(["Close the issue and provide details as needed"]) @@ -100,10 +100,9 @@ flowchart TD n6 -- Assign it to codeowner --> n7["Issue in being worked upon"] n6 -- No --> n8 n7 -- Once PR is merged --> n10 - n8 -- Wait for help from the community --> n9["Has someone volunteered?"] - n9 -- Yes --> n11["Assign it to the person"] - n12 -- Any activity? --> n9 - n9 -. Stale issue .-> n12["Issue in inactive"] + n8 -- When someone volunteers to provide a fix --> n11["Assign it to the person"] + n12 -- Any activity? --> n8 + n8 -. Stale issue .-> n12["Issue in inactive"] n11 --> n7 n12 -- Closed automatically after 120 days due to lack of activity --> n10 n4 -- Once enough details are available --> n2 @@ -112,7 +111,6 @@ flowchart TD n4@{ shape: rect} n2@{ shape: diam} n6@{ shape: diam} - n9@{ shape: diam} n1:::Aqua n3:::Ash