Skip to content

Commit f1443f9

Browse files
committed
docs(maintainers): add bug triaging section
1 parent f205008 commit f1443f9

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

MAINTAINERS.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
- [Contribution is stuck](#contribution-is-stuck)
2424
- [Insufficient feedback or information](#insufficient-feedback-or-information)
2525
- [Crediting contributions](#crediting-contributions)
26+
- [Is that a bug?](#is-that-a-bug)
2627
- [Inviting contributions](#inviting-contributions)
2728
- [Long running issues or PRs](#long-running-issues-or-prs)
2829

@@ -131,8 +132,11 @@ See [Common scenarios](#common-scenarios) section for additional guidance.
131132

132133
### Triage Bug Reports
133134

134-
> WORK-IN-PROGRESS
135-
> TODO: cover different types of bugs (internal, customer-facing, upstream), reference to releasing section
135+
Be familiar with [our definition of bug](#is-that-a-bug). If it's not a bug, you can close it or adjust its title and labels - always communicate the reason accordingly.
136+
137+
For bugs caused by upstream dependencies, replace `bug` with `bug-upstream` label. Ask the author whether they'd like to raise the issue upstream or if they prefer us to do so.
138+
139+
Assess the impact and make the call on whether we need an emergency release. Contact other [maintainers](#current-maintainers) when in doubt.
136140

137141
See [Common scenarios](#common-scenarios) section for additional guidance.
138142

@@ -147,7 +151,7 @@ Make sure you ask these questions in mind when reviewing:
147151
* Does it focus on the mechanics to solve the use case over fine-grained implementation details?
148152
* Can anyone familiar with the code base implement it?
149153
* If approved, are they interested in contributing? Do they need any guidance?
150-
* Does this significantly increase the overall project maintenance? e.g., lacks expertise in the team, fast moving target, etc.
154+
* Does this significantly increase the overall project maintenance? Do we have the necessary skills to maintain?
151155
* If we can't take this use case, are there alternative projects we could recommend? Or does it call for a new project altogether?
152156

153157
When necessary, be upfront that the time it takes to review, approve, and implement a RFC can vary - see [Contribution is stuck](#contribution-is-stuck). Some RFCs may be further updated after implementation, as certain areas become clearer.
@@ -208,6 +212,12 @@ When in doubt, use `need-more-information` or `need-customer-feedback` labels to
208212

209213
> TODO: mention release notes and provide an example.
210214
215+
### Is that a bug?
216+
217+
A bug produces incorrect or unexpected results at runtime that differs from its intended behavior. Bugs must be reproducible. They directly affect customers experience at runtime despite following its recommended usage.
218+
219+
Documentation snippets, use of internal components or unadvertised functionalities are not considered bugs.
220+
211221
### Inviting contributions
212222

213223
> TODO: sensitive labels to defer or prioritize work

0 commit comments

Comments
 (0)