Skip to content

Commit 3caff3d

Browse files
authored
added Triage document for weekly triages (opensearch-project#547)
Signed-off-by: Chinmay Gadgil <chinmay5j@gmail.com>
1 parent 7ebbfef commit 3caff3d

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

triage.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
## Table of Contents
2+
- [Scope](#scope)
3+
- [Schedule](#schedule)
4+
- [What Is Triaging](#what-is-triaging)
5+
- [How to Triage](#how-to-triage)
6+
7+
## Scope
8+
These guidelines serve as a primary document for triaging issues in [opensearch-benchmark](https://github.com/opensearch-project/opensearch-benchmark) and [opensearch-benchmark-workloads](https://github.com/opensearch-project/opensearch-benchmark-workloads) project. For maintainers/contributors, it is a guide to ensure that we address all customer issues and address feature requests in a timely manner.
9+
10+
## Schedule
11+
Every week a maintainer will be assigned on a rotational basis to conduct triage meeting.
12+
The meeting duration will be no more than 1 hour every Tuesday @1.30 PM PDT/3.30 PM CDT
13+
14+
## What is Triaging
15+
Triage is a process of grooming issues with correct labels, assigning them owners if available, ensuring that the issues have all the required information so that they are actionable
16+
17+
## How to Triage
18+
The steps listed below are not exhaustive and can be updated. Start with [opensearch-benchmark](https://github.com/opensearch-project/opensearch-benchmark) followed by [opensearch-benchmark-workloads](https://github.com/opensearch-project/opensearch-benchmark-workloads) project. For each of these projects we can follow the below steps to triage Issues from different categories. Try to cover at least 1 Issue from each of the below listed category.
19+
20+
### Steps to triage [opensearch-benchmark](https://github.com/opensearch-project/opensearch-benchmark)
21+
- [Untriaged](https://github.com/opensearch-project/opensearch-benchmark/issues?q=is%3Aopen+is%3Aissue+no%3Alabel)
22+
- First check if any of the untriaged issue is a duplicate. If yes, then comment the duplicate Issue link and close the duplicate
23+
- Assign appropriate labels for these Issues such as bug, enhancements, breaking etc.
24+
- If possible assign owners who could be [SME](https://en.wikipedia.org/wiki/Subject-matter_expert) for the Issue or volunteers if any
25+
26+
- [High Priority](https://github.com/opensearch-project/opensearch-benchmark/issues?q=is%3Aopen+is%3Aissue+label%3A%22High+Priority%22)
27+
- Search for Issues labeled as High Priority.
28+
- Ensure they have a status update or an owner
29+
30+
- [Breaking](https://github.com/opensearch-project/opensearch-benchmark/issues?q=is%3Aopen+is%3Aissue+label%3Abreaking)
31+
- Search for Issues which are labeled as breaking
32+
- Try to assign owners if it is a high priority beaking change
33+
34+
- [Bugs](https://github.com/opensearch-project/opensearch-benchmark/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
35+
- Search for Issues which are labeled as bugs
36+
- Comment with a status update such as In Progress, Not Planned, Needs more information
37+
38+
- [Enhancements](https://github.com/opensearch-project/opensearch-benchmark/issues?q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3Aenhancement+)
39+
- Search for Issues which are feature requests/enhancements
40+
- Comment with a status update and assign owners if it is going to be the next release candidate
41+
42+
- [Documentation](https://github.com/opensearch-project/opensearch-benchmark/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation)
43+
- These Issues although not breaking are important for better customer experience
44+
- Feel free to encourage the requester to raise a PR, these can be tagged as good first Issue as well
45+
46+
### Steps to triage [opensearch-benchmark-workloads](https://github.com/opensearch-project/opensearch-benchmark-workloads)
47+
- [Untriaged](https://github.com/opensearch-project/opensearch-benchmark-workloads/issues?q=is%3Aopen+is%3Aissue+no%3Alabel)
48+
- First check if any of the untriaged issue is a duplicate. If yes, then comment the duplicate Issue link and close the duplicate
49+
- Assign appropriate labels for these Issues such as bug, enhancements, breaking etc.
50+
- If possible assign owners who could be [SME](https://en.wikipedia.org/wiki/Subject-matter_expert) for the Issue or volunteers if any
51+
52+
- [Breaking](https://github.com/opensearch-project/opensearch-benchmark-workloads/issues?q=is%3Aopen+is%3Aissue+label%3Abreaking)
53+
- Search for Issues which are labeled as breaking
54+
- Try to assign owners if it is a high priority beaking change
55+
56+
- [Bugs](https://github.com/opensearch-project/opensearch-benchmark-workloads/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
57+
- Search for Issues which are labeled as bugs
58+
- Comment with a status update such as In Progress, Not Planned, Needs more information
59+
60+
- [Enhancement](https://github.com/opensearch-project/opensearch-benchmark-workloads/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement)
61+
- Search for Issues which are feature requests/enhancements
62+
- Comment with a status update and assign owners if it is going to be the next release candidate
63+
64+
- [Documentation](https://github.com/opensearch-project/opensearch-benchmark-workloads/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation)
65+
- These Issues although not breaking are important for better customer experience
66+
- Feel free to encourage the requester to raise a PR, these can be tagged as good first Issue as well
67+
68+
*There could be an overlap of Issues in more than 1 category such as Breaking and Bugs or Breaking and High Priority. In this case try to triage a different Issue which is not already covered*

0 commit comments

Comments
 (0)