From 289868175c2ce43ee90ad5525fe5ece917067830 Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Fri, 17 Apr 2020 16:05:56 -0500 Subject: [PATCH 1/5] Adding instructions for issue triaging --- docs/triaging.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/triaging.md diff --git a/docs/triaging.md b/docs/triaging.md new file mode 100644 index 00000000000..19899b2bb46 --- /dev/null +++ b/docs/triaging.md @@ -0,0 +1,46 @@ +Issue Triaging +============== + +OmnICU uses GitHub for tracking feature requests and work items. + +- All issues should have a type label. + - [Query: issues needing a type](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+-label%3Abug+-label%3Acore+-label%3Adocumentation+-label%3Aenhancement+-label%3Aquestion+-label%3Ainvalid) +- All *open* or *backlog* issues should have and assignee or **help wanted** label. + - [Query: open or backlog issues needing assignee or help wanted](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aopen+-label%3A%22help+wanted%22+no%3Aassignee+) +- All *closed* issues should have a resolution, linked pull request, or the **question** type. + - [Query: closed issues needing resolution or linked PR](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aclosed+-linked%3Apr+-label%3Aquestion+-label%3Abacklog) + +## Fields + +### Type + +The following labels are types; every issue should have one: + +- **bug** = a defect in existing code. +- **core** = a high-priority improvement or new feature. +- **documentation** = relates to documentation, including user guide, architecture design, team processes, and API docs. +- **enhancement** = a lower-priority improvement or new feature. +- **question** = an issue that can be addressed in the discussion thread without checking in any code or documentation. +- **invalid** = spam, etc. + +### Assignee + +The assignee is the user who is the "champion" for the issue: tracking its progress, obtaining the necessary approvals, and so forth. The assignee is often the same as the reporter. The assignee is not necesarilly the same as the user who is writing the necessary code fixes. + +An issue may have the **help wanted** label if there is no assignee. + +### Resolution + +All *closed* issues should have either (1) the "question" type, (2) a linked pull request, or (3) one of the following labels: + +- **backlog** = the issue is not fixed, but it could be revisited in the future. +- **duplicate** = the issue is a duplicate of some other issue. +- **needs more info** = the issue might be valid, but the subcommittee either does not understand the issue or was unable to reproduce it. The reporter should provide more information. +- **obsolete** = the issue is superseded or no longer relevant. +- **wontfix** = the issue is valid, but the subcommittee has concluded that the library is working as intended. + +### Optional Labels + +The following labels are optional and can be applied to an issue if appropriate: + +- **good first issue** = this would be good for a new contributor. From 611f4c310ed561293ab91e243cf874603a07912b Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Fri, 17 Apr 2020 16:23:14 -0500 Subject: [PATCH 2/5] core -> core feature --- docs/triaging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/triaging.md b/docs/triaging.md index 19899b2bb46..bb8ddb0c2d4 100644 --- a/docs/triaging.md +++ b/docs/triaging.md @@ -17,7 +17,7 @@ OmnICU uses GitHub for tracking feature requests and work items. The following labels are types; every issue should have one: - **bug** = a defect in existing code. -- **core** = a high-priority improvement or new feature. +- **core feature** = a high-priority improvement or new feature. - **documentation** = relates to documentation, including user guide, architecture design, team processes, and API docs. - **enhancement** = a lower-priority improvement or new feature. - **question** = an issue that can be addressed in the discussion thread without checking in any code or documentation. From 61da620c4b0f249d932373c5e4b6dd6f421f9cd0 Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Fri, 17 Apr 2020 16:24:00 -0500 Subject: [PATCH 3/5] Fix search query for "core feature" --- docs/triaging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/triaging.md b/docs/triaging.md index bb8ddb0c2d4..5e6d0e56296 100644 --- a/docs/triaging.md +++ b/docs/triaging.md @@ -4,7 +4,7 @@ Issue Triaging OmnICU uses GitHub for tracking feature requests and work items. - All issues should have a type label. - - [Query: issues needing a type](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+-label%3Abug+-label%3Acore+-label%3Adocumentation+-label%3Aenhancement+-label%3Aquestion+-label%3Ainvalid) + - [Query: issues needing a type](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+-label%3Abug+-label%3A%22core+feature%22+-label%3Adocumentation+-label%3Aenhancement+-label%3Aquestion+-label%3Ainvalid+) - All *open* or *backlog* issues should have and assignee or **help wanted** label. - [Query: open or backlog issues needing assignee or help wanted](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aopen+-label%3A%22help+wanted%22+no%3Aassignee+) - All *closed* issues should have a resolution, linked pull request, or the **question** type. From 6d7ca6a6774fff563ca9957dcef09c365e1f8b19 Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Fri, 17 Apr 2020 16:48:47 -0500 Subject: [PATCH 4/5] Add more information about open versus backlog. --- docs/triaging.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/triaging.md b/docs/triaging.md index 5e6d0e56296..f5bf5344771 100644 --- a/docs/triaging.md +++ b/docs/triaging.md @@ -6,9 +6,14 @@ OmnICU uses GitHub for tracking feature requests and work items. - All issues should have a type label. - [Query: issues needing a type](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+-label%3Abug+-label%3A%22core+feature%22+-label%3Adocumentation+-label%3Aenhancement+-label%3Aquestion+-label%3Ainvalid+) - All *open* or *backlog* issues should have and assignee or **help wanted** label. - - [Query: open or backlog issues needing assignee or help wanted](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aopen+-label%3A%22help+wanted%22+no%3Aassignee+) + - [Query: open issues needing assignee or help wanted](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aopen+-label%3A%22help+wanted%22+no%3Aassignee+) + - [Query: backlog issues needing assignee or help wanted](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aclosed+label%3Abacklog+-label%3A%22help+wanted%22+no%3Aassignee) - All *closed* issues should have a resolution, linked pull request, or the **question** type. - [Query: closed issues needing resolution or linked PR](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aclosed+-linked%3Apr+-label%3Aquestion+-label%3Abacklog) +- If an issue is open, the issue should be actionable. Open issues should generally have an activity update once every 60 days. + - [Query: least recently updated open issues](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc) +- If an issue is unresolved but lower-priority or not immediately actionable, it should get the **backlog** label and be closed. The backlog should be checked periodically for issues that should be reopened. + - [Query: most recently updated backlog issues](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aclosed+label%3Abacklog+sort%3Aupdated-desc+) ## Fields From 729164e5cfbf1a5bcb6abaaae2fe860e0a308a5c Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Fri, 17 Apr 2020 19:05:53 -0500 Subject: [PATCH 5/5] Fix typo --- docs/triaging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/triaging.md b/docs/triaging.md index f5bf5344771..363465cbe24 100644 --- a/docs/triaging.md +++ b/docs/triaging.md @@ -5,7 +5,7 @@ OmnICU uses GitHub for tracking feature requests and work items. - All issues should have a type label. - [Query: issues needing a type](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+-label%3Abug+-label%3A%22core+feature%22+-label%3Adocumentation+-label%3Aenhancement+-label%3Aquestion+-label%3Ainvalid+) -- All *open* or *backlog* issues should have and assignee or **help wanted** label. +- All *open* or *backlog* issues should have an assignee or **help wanted** label. - [Query: open issues needing assignee or help wanted](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aopen+-label%3A%22help+wanted%22+no%3Aassignee+) - [Query: backlog issues needing assignee or help wanted](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aclosed+label%3Abacklog+-label%3A%22help+wanted%22+no%3Aassignee) - All *closed* issues should have a resolution, linked pull request, or the **question** type.