Skip to content

Commit 2d7e5a0

Browse files
committed
Add task management doc + rename TSG
1 parent 77ffa25 commit 2d7e5a0

File tree

3 files changed

+48
-1
lines changed

3 files changed

+48
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ MsQuic has several features that differentiates it from other QUIC implementatio
6363
* For using the API, see the [API docs](./docs/API.md) or the [Sample](./src/tools/sample/sample.c).
6464
* For running a sample server and client app, see the [Quick Start Guide](./docs/Sample.md).
6565
* For deploying QUIC, see the [Deployment docs](./docs/Deployment.md).
66-
* For diagnosing issues, see the [Diagnostics docs](./docs/Diagnostics.md) and the [Trouble Shooting Guide](./docs/TSG.md).
66+
* For diagnosing issues, see the [Diagnostics docs](./docs/Diagnostics.md) and the [Trouble Shooting Guide](./docs/TroubleShootingGuide.md).
6767
* For other frequently asked questions, see the [FAQs](./docs/FAQ.md).
6868

6969
# Contributing

docs/TaskManagement.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# MsQuic Task management
2+
3+
## Work item states
4+
5+
| State | Mark | Other Details | Query Example |
6+
|--------------------------|-------------------------------------|--------------------------------------------------------|-------------------------------------------------------|
7+
| **Triage Needed** | Not in any other state | | [`is:issue state:open no:project -label:"help wanted"`](https://github.com/microsoft/msquic/issues?q=is%3Aissue%20state%3Aopen%20no%3Aproject%20-label%3A%22help%20wanted%22) |
8+
| **Non-prioritized Work** | Not in DPT project, `help wanted` | Type, Area | [`is:issue state:open label:"help wanted"`](https://github.com/microsoft/msquic/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22) |
9+
| **Backlog** | In DPT project, no status | Type, Area, Priority, T-Shirt size | [Backlog - DPT Iteration Tracker](https://github.com/orgs/microsoft/projects/1617/views/6) |
10+
| **Current Work** | In DPT project, Planned/In Progress | Type, Area, Priority, T-Shirt size, Iteration, Assignee| [Breakdown - DPT Iteration Tracker](https://github.com/orgs/microsoft/projects/1617/views/1) |
11+
| **Closed** | Closed | Reason label if not completed (e.g., Cut: NotRepro) | |
12+
13+
14+
### Triage Needed
15+
16+
Every newly created work items must be triaged to evaluate whether it should be worked on and with which priority.
17+
A work item is in the “Triage needed” state by default until it is assigned to another state.
18+
19+
Work items are triaged in a regular team triage meeting:
20+
- the work item is moved to one of the category below
21+
- common metadata is added: Type (Bug / Task / Feature), Area label (`Area: *`), Priority (P0 to P3), T-Shirt size (XS to XL)...
22+
23+
### Help wanted
24+
25+
Some work items, while interesting, are not aligned with our priorities.
26+
These work items are labeled with `help wanted` and are not added in the "DPT Iteration Tracker" project nor prioritized.
27+
If there is interest about addressing these work items, a contribution would be welcome.
28+
29+
During triage, these work item should be labeled with `help wanted`, and receive a type and area labels (`Area: *`).
30+
31+
### Backlog
32+
33+
The work items the team plans to work on in the future, prioritized and roughly sized.
34+
35+
During triage, these work items should be added to the “DPT Iteration tracker” project without a status, and get a type, a priority (P0 to P3), a T-Shirt size (XS to XL), and an area label (`Area: *`). If relevant, a partner label (`Partner: *`) should also be added.
36+
37+
### Current work
38+
39+
Work items that have been picked up by the team to be worked on during a specific iteration.
40+
41+
During triage/planning, they should get the “Planned” status, an iteration and be assigned to a dev, in addition to what is set to backlog items.
42+
When working on the item, the assignee should change the state to “In Progress”, then “Done” to reflect progress.
43+
44+
### Closed
45+
46+
Work items that don’t require additional work are closed. They can be completed or cut.
47+
If the work item was not completed, it should be labeled with `Cut: *` (NotRepro / WontFix/ Duplicate...).
File renamed without changes.

0 commit comments

Comments
 (0)