Skip to content

Commit

Permalink
Work mode: update to reflect github labels, and progress tracking
Browse files Browse the repository at this point in the history
  • Loading branch information
rhiaro committed May 6, 2024
1 parent d5083a0 commit bb583ce
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions workmode/design-reviews/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,25 +45,27 @@ First, we check all relevant information is included, that the explainer is in s

We apply **labels** according to the following, to help us decide how to proceed with a review:

* Any deadlines in the request.
* `Priority`: Any deadlines in the request.
* At which **stage** the proposal has come in:
* horizontal review from a WG
* early review from a CG
* early review from a browser process
* request from a WG that is not part of HR
* The **size** of the review:
* `Review type`: The **size** of the review:
* A complex domain?
* A small delta?
* Major gaps in the proposal?
* Contentious issues that need to be resolved?
* What should the **primary area** of focus be?
* `Focus`: What should the **primary area** of focus be?
* API design
* Security
* Privacy
* Accessibility
* Internationalisation
* Web architecture

We also label with `Topic`, `Venue` and `Provenance` to help us organise our issues.

During triage, we might decline a request for any reason (see below).
For reviews that we accept, we will **label** review requests with a _mode_:

Expand All @@ -85,11 +87,13 @@ When prioritising issues to work on, we:
* Prioritise proposals with a clear path to standardisation, including multiple implementations.
* Prioritise based on an assessment of impact, preferring proposals where review will add more value.

We may use `Priority` labels to track whether something is urgent.

### Review areas

It is usually best to review new features/specifications/proposals with expertise from several different areas.

We do this by passing a review between different TAG members, depending on the area they are best equipped to cover. We use labels to indicate the status of each part of the review (eg. `API review: pending` / `API review: complete`). A review is complete when all areas have been marked as complete (or not applicable).
We do this by passing a review between different TAG members, depending on the **focus area** they are best equipped to cover. We use labels to indicate the status of each part of the review (eg. `Focus: API review (pending)` / `Focus: API review (complete)`). A review is complete when all focus areas have been marked as complete (or not applicable).

Broadly, the areas we cover most commonly are:

Expand Down Expand Up @@ -155,6 +159,12 @@ If any area of a review can be completed asynchronously, any individual TAG memb

We keep each other updated about any reviews that were completed asynchronously during our plenary calls.

## Tracking progress

We use github labels beginning with `Progress:` to track the current status of a review at a glance. When a review is complete, there should be no `Progress` labels attached.

We update the `Focus:` labels to say `pending` or `complete` for each focus area as we do the review. Sometimes this is done in parts, by different TAG members; sometimes a single response will cover all of the releavnt focus areas.

## Resolutions

When we complete a review, we use labels to indicate the disposition of the review. The definitions of these are as follows.
Expand Down

0 comments on commit bb583ce

Please sign in to comment.