Skip to content

Commit e7ec946

Browse files
authored
Update README with triage priorities (#1436)
* Update README with triage priorities * actually add the readme * revert changelog change, oops. * User performance problem added to triage guide per Hixie
1 parent e15f074 commit e7ec946

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,47 @@ all the used libraries, even from other packages, to the list of the documented
121121

122122
## Issues and bugs
123123

124-
Please file reports on the [GitHub Issue Tracker][].
124+
Please file reports on the [GitHub Issue Tracker][]. Issues are labeled with
125+
priority based on how much impact to the ecosystem the issue addresses and
126+
the number of generated pages that show the anomaly (widespread vs. not
127+
widespread).
128+
129+
Some examples of likely triage priorities:
130+
131+
* P0
132+
* Broken links, widespread
133+
* Uncaught exceptions, widespread
134+
* Incorrect linkage, widespread
135+
* Very ugly or navigation impaired generated pages, widespread
136+
137+
* P1
138+
* Broken links, few or on edge cases
139+
* Uncaught exceptions, very rare or with simple workarounds
140+
* Incorrect linkage, few or on edge cases
141+
* Incorrect doc contents, widespread or with high impact
142+
* Minor display warts not significantly impeding navigation, widespread
143+
* Default-on warnings that are misleading or wrong, widespread
144+
* Generation problems that should be detected but aren't warned, widespread
145+
* Enhancements that have significant data around them indicating they are a big win
146+
* User performance problem (e.g. page load, search), widespread
147+
148+
* P2
149+
* Incorrect doc contents, not widespread
150+
* Minor display warts not significantly impeding navigation, not widespread
151+
* Generation problems that should be detected but aren't warned, not widespread
152+
* Default-on warnings that are misleading or wrong, few or on edge cases
153+
* Non-default warnings that are misleading or wrong, widespread
154+
* Enhancements considered important but without significant data indicating they are a big win
155+
* User performance problem (e.g. page load, search), not widespread
156+
* Generation performance problem, widespread
157+
158+
* P3
159+
* Theoretical or extremely rare problems with generation
160+
* Minor display warts on edge cases only
161+
* Non-default warnings that are misleading or wrong, few or on edge cases
162+
* Enhancements whose importance is uncertain
163+
* Generation performance problem, limited impact or not widespread
164+
125165

126166
## License
127167

0 commit comments

Comments
 (0)