From 302324636937c99797fa04604f07a4b283286a1c Mon Sep 17 00:00:00 2001 From: Artak <34246760+mkArtakMSFT@users.noreply.github.com> Date: Thu, 9 Nov 2023 09:23:24 -0800 Subject: [PATCH 1/5] Update HelpWantedProcess.md Update the process to include summary comment link in the description of the issue. This is important as I have noticed some issues have a long comment list and it's hard to discover the summary comment. Here is an example where I've noticed this: https://github.com/dotnet/aspnetcore/issues/47054 --- docs/HelpWantedProcess.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/HelpWantedProcess.md b/docs/HelpWantedProcess.md index 7ce3662c4204..65aece237381 100644 --- a/docs/HelpWantedProcess.md +++ b/docs/HelpWantedProcess.md @@ -10,6 +10,14 @@ This process (we'll refer to it as `help-wanted` process going forward) triggers 3. As part of filling out the template, the engineer will also need to **describe a high-level design for how to approach the problem and how it can be solved**. 4. When all the sections of the template are filled in, the engineer will then need to **apply one of the `Complexity: ` labels**, to indicate how easy / hard will it be to tackle the issue. This will help community members to find the right type of issue to contribute to. -5. After posting this comment, the assigned **engineer will unassign themself** from the issue and will **replace the `help-candidate` label with `help-wanted` label**, as an indicator, that the issue is ready for the community to pick up. +5. After posting this comment the assigned engineer should: + - unassign themself from the issue + - **replace the `help-candidate` label with `help-wanted` label**, as an indicator, that the issue is ready for the community to pick up. + - Copy the direct link to the summary comment and add the link to the bottom of the description of the issue to help with discoverability, as there can be too many comments in the issue and the summary comment may be hard to find. + Here is an example comment to use: + +``` +**Summary Comment** : https://github.com/dotnet/aspnetcore/issues/51912#issuecomment-1801246403 +``` This will conclude the process. From 83bb9a8fa7ee92165193d9370c9d80962dad9344 Mon Sep 17 00:00:00 2001 From: Artak <34246760+mkArtakMSFT@users.noreply.github.com> Date: Thu, 9 Nov 2023 10:30:56 -0800 Subject: [PATCH 2/5] Update docs/HelpWantedProcess.md Co-authored-by: Mackinnon Buck --- docs/HelpWantedProcess.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/HelpWantedProcess.md b/docs/HelpWantedProcess.md index 65aece237381..a6994b3450cd 100644 --- a/docs/HelpWantedProcess.md +++ b/docs/HelpWantedProcess.md @@ -11,8 +11,8 @@ This process (we'll refer to it as `help-wanted` process going forward) triggers 4. When all the sections of the template are filled in, the engineer will then need to **apply one of the `Complexity: ` labels**, to indicate how easy / hard will it be to tackle the issue. This will help community members to find the right type of issue to contribute to. 5. After posting this comment the assigned engineer should: - - unassign themself from the issue - - **replace the `help-candidate` label with `help-wanted` label**, as an indicator, that the issue is ready for the community to pick up. + - Unassign themself from the issue. + - **Replace the `help-candidate` label with `help-wanted` label**, as an indicator, that the issue is ready for the community to pick up. - Copy the direct link to the summary comment and add the link to the bottom of the description of the issue to help with discoverability, as there can be too many comments in the issue and the summary comment may be hard to find. Here is an example comment to use: From ffe0ae62a40835411964c07a27285c20ccdab403 Mon Sep 17 00:00:00 2001 From: Artak <34246760+mkArtakMSFT@users.noreply.github.com> Date: Thu, 9 Nov 2023 10:31:04 -0800 Subject: [PATCH 3/5] Update docs/HelpWantedProcess.md Co-authored-by: Mackinnon Buck --- docs/HelpWantedProcess.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/HelpWantedProcess.md b/docs/HelpWantedProcess.md index a6994b3450cd..fe5cd5752fe6 100644 --- a/docs/HelpWantedProcess.md +++ b/docs/HelpWantedProcess.md @@ -16,7 +16,7 @@ This process (we'll refer to it as `help-wanted` process going forward) triggers - Copy the direct link to the summary comment and add the link to the bottom of the description of the issue to help with discoverability, as there can be too many comments in the issue and the summary comment may be hard to find. Here is an example comment to use: -``` +```text **Summary Comment** : https://github.com/dotnet/aspnetcore/issues/51912#issuecomment-1801246403 ``` From 1a3f6719cc06dac0280b07bf8cdbe93eacc43537 Mon Sep 17 00:00:00 2001 From: Artak <34246760+mkArtakMSFT@users.noreply.github.com> Date: Thu, 9 Nov 2023 11:16:33 -0800 Subject: [PATCH 4/5] Update docs/HelpWantedProcess.md Co-authored-by: Stephen Halter --- docs/HelpWantedProcess.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/HelpWantedProcess.md b/docs/HelpWantedProcess.md index fe5cd5752fe6..651f53dc76f7 100644 --- a/docs/HelpWantedProcess.md +++ b/docs/HelpWantedProcess.md @@ -14,10 +14,10 @@ This process (we'll refer to it as `help-wanted` process going forward) triggers - Unassign themself from the issue. - **Replace the `help-candidate` label with `help-wanted` label**, as an indicator, that the issue is ready for the community to pick up. - Copy the direct link to the summary comment and add the link to the bottom of the description of the issue to help with discoverability, as there can be too many comments in the issue and the summary comment may be hard to find. - Here is an example comment to use: + Here is an example comment to use: -```text -**Summary Comment** : https://github.com/dotnet/aspnetcore/issues/51912#issuecomment-1801246403 -``` + ```text + **Summary Comment** : https://github.com/dotnet/aspnetcore/issues/51912#issuecomment-1801246403 + ``` This will conclude the process. From 69e9a00c38948d30122cf6fadc3571a6a0407dea Mon Sep 17 00:00:00 2001 From: Artak <34246760+mkArtakMSFT@users.noreply.github.com> Date: Thu, 9 Nov 2023 12:54:52 -0800 Subject: [PATCH 5/5] Update docs/HelpWantedProcess.md --- docs/HelpWantedProcess.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/HelpWantedProcess.md b/docs/HelpWantedProcess.md index 651f53dc76f7..83911acda7df 100644 --- a/docs/HelpWantedProcess.md +++ b/docs/HelpWantedProcess.md @@ -12,7 +12,7 @@ This process (we'll refer to it as `help-wanted` process going forward) triggers This will help community members to find the right type of issue to contribute to. 5. After posting this comment the assigned engineer should: - Unassign themself from the issue. - - **Replace the `help-candidate` label with `help-wanted` label**, as an indicator, that the issue is ready for the community to pick up. + - **Replace the `help candidate` label with `help wanted` label**, as an indicator, that the issue is ready for the community to pick up. - Copy the direct link to the summary comment and add the link to the bottom of the description of the issue to help with discoverability, as there can be too many comments in the issue and the summary comment may be hard to find. Here is an example comment to use: