added Triage document for weekly triages #547
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
IanHoang
requested changes
Jun 10, 2024
gkamat
requested changes
Jun 12, 2024
Signed-off-by: Chinmay Gadgil <chinmay5j@gmail.com> fixed anchor links Signed-off-by: Chinmay Gadgil <chinmay5j@gmail.com> updated triage.md based on comments Signed-off-by: Chinmay Gadgil <chinmay5j@gmail.com>
IanHoang
approved these changes
Jun 14, 2024
gkamat
requested changes
Jun 25, 2024
| The meeting duration will be no more than 1 hour every Tuesday @1.30 PM PDT/3.30 PM CDT | ||
|
|
||
| ## What is Triaging | ||
| 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 |
There was a problem hiding this comment.
Triaging is the process of prioritizing issues to be acted on, grooming them with correct labels...
| - [How to Triage](#how-to-triage) | ||
|
|
||
| ## Scope | ||
| 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. |
There was a problem hiding this comment.
This document provides guidelines for the triaging of GitHub issues in the ... and ... repositories.
| 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 | ||
|
|
||
| ## How to Triage | ||
| 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. |
There was a problem hiding this comment.
project/projects -> repository/repositories
For each of these projects we can follow the steps below to triage issues from different categories. Try to cover at least one issue from each of the below listed categories.
| ### Steps to triage [opensearch-benchmark](https://github.com/opensearch-project/opensearch-benchmark) | ||
| - [Untriaged](https://github.com/opensearch-project/opensearch-benchmark/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) | ||
| - First check if any of the untriaged issue is a duplicate. If yes, then comment the duplicate Issue link and close the duplicate | ||
| - Assign appropriate labels for these Issues such as bug, enhancements, breaking etc. |
There was a problem hiding this comment.
Assign a priority label to the issue, if appropriate.
|
|
||
| - [Bugs](https://github.com/opensearch-project/opensearch-benchmark-workloads/issues?q=is%3Aopen+is%3Aissue+label%3Abug) | ||
| - Search for Issues which are labeled as bugs | ||
| - Comment with a status update such as In Progress, Not Planned, Needs more information |
There was a problem hiding this comment.
Add a priority label if the issue warrants it.
|
|
||
| - [Enhancement](https://github.com/opensearch-project/opensearch-benchmark-workloads/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) | ||
| - Search for Issues which are feature requests/enhancements | ||
| - Comment with a status update and assign owners if it is going to be the next release candidate |
There was a problem hiding this comment.
Add comments as needed and ensure an owner is assigned if the feature is scheduled for the next release.
| - These Issues although not breaking are important for better customer experience | ||
| - Feel free to encourage the requester to raise a PR, these can be tagged as good first Issue as well | ||
|
|
||
| *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* |
There was a problem hiding this comment.
Notwithstanding the steps laid out above, some issues may fall into multiple categories and need to be triaged only once.
gkamat
approved these changes
Jun 26, 2024
finnroblin
pushed a commit
to finnroblin/opensearch-benchmark
that referenced
this pull request
Jul 19, 2024
Signed-off-by: Chinmay Gadgil <chinmay5j@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
[Describe what this change achieves]
This PR is to start gathering feedback and update triage.md
Testing
NA
[Describe how this change was tested]
rendered the markdown in local setup
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.