Skip to content

Commit 032f6d7

Browse files
Patrick Sachsmfalken
authored andcommitted
Minor Readme format changes (#1376)
Minor update to the README to increase readability. I inserted a newline between "Risk labels for impacts MVP issues" and added bullet points in various places.
1 parent fe1440b commit 032f6d7

File tree

1 file changed

+16
-28
lines changed

1 file changed

+16
-28
lines changed

README.md

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,41 +28,29 @@ This is to explain how we use labels and milestones to triage the issues. Note:
2828

2929

3030
### Prioritization
31-
**enhancement**: is for anything that was assessed as not having any impact on the decisions for the current milestone and can therefore be safely discussed, rejected or prioritized later.
32-
33-
**milestone**: is used to mark issues we agreed to get done in principle by a given revision. For the sake of efficiency, we tend to only focus on the current milestone and leave everything else without specific milestones.
34-
35-
**impacts MVP**: is used to mark issues impacting the “Minimal Viable Product”. The MVP is the minimal scope of API that can solve actual use cases. These issues have the highest priority.
31+
- **enhancement**: is for anything that was assessed as not having any impact on the decisions for the current milestone and can therefore be safely discussed, rejected or prioritized later.
32+
- **milestone**: is used to mark issues we agreed to get done in principle by a given revision. For the sake of efficiency, we tend to only focus on the current milestone and leave everything else without specific milestones.
33+
- **impacts MVP**: is used to mark issues impacting the “Minimal Viable Product”. The MVP is the minimal scope of API that can solve actual use cases. These issues have the highest priority.
3634

3735
*Risk labels for impacts MVP issues*
38-
**medium risk**: to further refine the “impacts MVP” issues. It indicates that the issue is moderately complex and that reaching a conclusion might take some time. These are of higher priority than issues with no risk label but are of lower priority than issues with a “high risk” label.
3936

40-
**high risk**: to further refine the “impacts MVP” issues. It indicates that the issue is significantly complex and that reaching a conclusion might take a lot of time and effort. These are of higher priority than issues with no risk label or a “medium risk” label.
37+
- **medium risk**: to further refine the “impacts MVP” issues. It indicates that the issue is moderately complex and that reaching a conclusion might take some time. These are of higher priority than issues with no risk label but are of lower priority than issues with a “high risk” label.
38+
- **high risk**: to further refine the “impacts MVP” issues. It indicates that the issue is significantly complex and that reaching a conclusion might take a lot of time and effort. These are of higher priority than issues with no risk label or a “medium risk” label.
4139

4240

4341

4442
### Actions
45-
**needs spec**: a decision has been made and the spec needs to be updated.
46-
47-
**spec detail**: has no significant implications for implementers nor web developers.
48-
49-
**decided**: to record that a decision has been made.
50-
51-
**invalid**: when something doesn’t constitute a valid issue.
52-
53-
**wontfix**: a decision has been made not to pursue this issue further.
54-
55-
**duplicate**: when a similar issue has already been filed.
56-
57-
**bug**: an oversight that needs to be fixed.
43+
- **needs spec**: a decision has been made and the spec needs to be updated.
44+
- **spec detail**: has no significant implications for implementers nor web developers.
45+
- **decided**: to record that a decision has been made.
46+
- **invalid**: when something doesn’t constitute a valid issue.
47+
- **wontfix**: a decision has been made not to pursue this issue further.
48+
- **duplicate**: when a similar issue has already been filed.
49+
- **bug**: an oversight that needs to be fixed.
5850

5951

6052
### Areas
61-
62-
**fetch**: relates to Fetch
63-
64-
**lifecycle**: relates to lifecycle aspects of service worker
65-
66-
**cache**: relevant to the Cache APIs
67-
68-
**question**: not an actual issue. Items that have been filed in order to gain a better understanding of service worker.
53+
- **fetch**: relates to Fetch
54+
- **lifecycle**: relates to lifecycle aspects of service worker
55+
- **cache**: relevant to the Cache APIs
56+
- **question**: not an actual issue. Items that have been filed in order to gain a better understanding of service worker.

0 commit comments

Comments
 (0)