From bdcd9e7e4ee6fda3c84f703169f1069e8331af3a Mon Sep 17 00:00:00 2001 From: Daniel McKnight <34697904+NeonDaniel@users.noreply.github.com> Date: Fri, 17 May 2024 14:41:45 -0700 Subject: [PATCH] Document workflow for triaging GitHub issues (#47) * Document workflow for triaging GitHub issues * Add note to apply `duplicate` tag to duplicate issues --------- Co-authored-by: Daniel McKnight --- docs/operations/git/triage_issues.md | 27 +++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 28 insertions(+) create mode 100644 docs/operations/git/triage_issues.md diff --git a/docs/operations/git/triage_issues.md b/docs/operations/git/triage_issues.md new file mode 100644 index 00000000..a75d775e --- /dev/null +++ b/docs/operations/git/triage_issues.md @@ -0,0 +1,27 @@ +## Triage GitHub Issues +This describes the process for triaging new issues on GitHub + +### Application +This process applies in the following situations: +- A new issue is created in a repository you maintain +- A weekly review of the [GitHub Issues Report](https://github.com/NeonGeckoCom/.github/actions/workflows/get_issues.yml) +> The process below applies to each issue + +### Process +- Open the new issue on GitHub. +- Read the issue comment and verify it is valid and complete. + - If this is a duplicate issue, apply the `duplicate` tag, close it with a comment linking the existing issue. + - If the issue is mis-categorized as a bug or feature, update the PR title. + - If the issue is in the wrong repository, transfer it as appropriate. +- If you know about more context (i.e. a chat thread or forum post), add it to the issue description. +- If more information is needed for debugging, reply to the issue asking the author to clarify. +- Verify the correct labels are applied (`bug`, `enhancement`, `documentation`, etc.) +- Assign the issue to the "Community Projects" board if applicable. + > Issues in public repositories generally belong here in the "Other Helpful Tasks" section. +- If you are going to address the issue, assign yourself to the issue. +- If the issue can be addressed by a community member with minimal knowledge of other + interacting repositories, add the `help wanted` label. +- If the `triage` label is applied to the issue, remove it + +### Exceptions +- There should be no exceptions to this process. diff --git a/mkdocs.yml b/mkdocs.yml index 3038328d..bc2ed145 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -113,6 +113,7 @@ nav: - Alpha Release Review Workflow: operations/libraries/workflow_review_alpha.md - Git: - Undo a Stable PR Workflow: operations/git/undo_stable_pr.md + - Triage New GitHub Issues: operations/git/triage_issues.md - Skills: - Stable Release Workflow: operations/skills/workflow_stable_release.md - Alpha Release Workflow: operations/skills/workflow_alpha_release.md