From 104b85398c6f24ed76e8c8a48d45cd7f6cd1bb63 Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Mon, 7 Dec 2020 15:16:53 -0500 Subject: [PATCH 1/2] doc: Describe issue triaging --- doc/triage.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 doc/triage.md diff --git a/doc/triage.md b/doc/triage.md new file mode 100644 index 000000000..64b4afb86 --- /dev/null +++ b/doc/triage.md @@ -0,0 +1,17 @@ +# Triage + +Triaging code-server issues is done with the following issue filter: + +``` +is:open no:project sort:created-asc -label:blocked -label:upstream +``` + +We cannot work on any `blocked` or `upstream` issues as those are best handled by the +VS Code team. However, in certain circumstances we may fix them only in code-server if +necessary. + +The GitHub project where we manage all our actionable issues is at: +https://github.com/cdr/code-server/projects/1 + +Finally, we use milestones to track what issues are planned/or were closed for what release. +https://github.com/cdr/code-server/milestones From 30994a566f2d558da7904f9c3d61e694b0113a1c Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Mon, 7 Dec 2020 16:47:28 -0500 Subject: [PATCH 2/2] doc: Elaborate on issue triaging --- doc/triage.md | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/doc/triage.md b/doc/triage.md index 64b4afb86..e508df414 100644 --- a/doc/triage.md +++ b/doc/triage.md @@ -1,17 +1,37 @@ # Triage +## Filter + Triaging code-server issues is done with the following issue filter: ``` -is:open no:project sort:created-asc -label:blocked -label:upstream +is:issue is:open no:project sort:created-asc -label:blocked -label:upstream -label:waiting-for-info -label:extension-request ``` -We cannot work on any `blocked` or `upstream` issues as those are best handled by the -VS Code team. However, in certain circumstances we may fix them only in code-server if -necessary. +This will show issues that: -The GitHub project where we manage all our actionable issues is at: -https://github.com/cdr/code-server/projects/1 +1. Are open. +2. Have no assigned project. +3. Are not `blocked` or tagged for work by `upstream` (VS Code core team) + - If an upstream issue is detrimental to the code-server experience we may fix it in + our patch instead of waiting for the VS Code team to fix it. + - Someone should periodically go through these issues to see if they can be unblocked + though! +4. Are not in `waiting-for-info`. +5. Are not extension requests. -Finally, we use milestones to track what issues are planned/or were closed for what release. -https://github.com/cdr/code-server/milestones +## Process + +1. If an issue is a question/discussion it should be converted into a GitHub discussion. +2. Next, give the issue the appropriate labels and feel free to create new ones if + necessary. + - There are no hard and set rules for labels. We don't have many so look through and + see how they've been used throughout the repository. They all also have descriptions. +3. If more information is required, please ask the submitter and tag as + `waiting-for-info` and wait. +4. Finally, the issue should be moved into the + [code-server](https://github.com/cdr/code-server/projects/1) project where we pick + out issues to fix and track their progress. + +We also use [milestones](https://github.com/cdr/code-server/milestones) to track what +issues are planned/or were closed for what release.