forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add TRIAGING.md for triage agenda and processes
Documents the repository wide triaging processes for OpenSearch - Meeting format and agenda - Public meeting schedule - Weekly Wed - 10a CT - Commonly used labels - Triaging outcomes and canned responses Signed-off-by: Peter Nied <[email protected]>
- Loading branch information
Showing
1 changed file
with
71 additions
and
0 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| <img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px"> | ||
|
|
||
| The maintainers of the OpenSearch Repo seek to promote an inclusive and engaged community of contributors. In order to facilitate this, weekly triage meetings are open-to-all and attendance is encouraged for anyone who hopes to contribute, discuss an issue, or learn more about the project. To learn more about contributing to the OpenSearch Repo visit the [Contributing](./CONTRIBUTING.md) documentation. | ||
|
|
||
| ### Do I need to attend for my issue to be addressed/triaged? | ||
|
|
||
| Attendance is not required for your issue to be triaged or addressed. All new issues are triaged weekly. | ||
|
|
||
| ### What happens if my issue does not get covered this time? | ||
|
|
||
| Each meeting we seek to address all new issues. However, should we run out of time before your issue is discussed, you are always welcome to attend the next meeting or to follow up on the issue post itself. | ||
|
|
||
| ### How do I join the Triage meeting? | ||
|
|
||
| Meetings are hosted regularly at 10:00a - 10:55a Central Time every Wednesday and can be joined via [Chime](https://chime.aws/1988437365). | ||
|
|
||
| After joining the Chime meeting, you can enable your video / voice to join the discussion. If you do not have a webcam or microphone available, you can still join in via the text chat. | ||
|
|
||
| If you have an issue you'd like to bring forth please prepare a link to the issue so it can be presented and viewed by everyone in the meeting. | ||
|
|
||
| ### Is there an agenda for each week? | ||
|
|
||
| Meetings are 55 minutes and structured as follows: | ||
|
|
||
| 1. Initial Gathering: As we gather, feel free to turn on video and engage in informal and open-to-all conversation. After a bit a volunteer will share their screen and proceed with the agenda. | ||
| 2. Collect attendee annotations: The meeting driver will ask all triage attendee to post a link to their GitHub profile, these will be collected and assembled these into a signature to annotation all issues triaged during this meeting. | ||
| - Format of annotation should follow ``[Triage - attendees [1](https://github.com/peternied), [2](...)]`` | ||
| 3. Announcements: If there are any announcements to be made they will happen at the start of the meeting. | ||
| 4. Review of New Issues: The meetings always start with reviewing all untriaged [issues](https://github.com/search?q=label%3Auntriaged+is%3Aopen++repo%3Aopensearch-project%2FOpenSearch+&type=issues&ref=advsearch&s=created&o=desc) for the OpenSearch repo. | ||
| 5. Member Requests: Opportunity for any meeting member to ask for consideration of an issue or pull request. | ||
| 6. Open Discussion: Allow for members of the meeting to surface any topics without issues filed or pull request created. | ||
|
|
||
| ### Do I need to have already contributed to the project to attend a triage meeting? | ||
|
|
||
| No, all are welcome and encouraged to attend. Attending the Triage meetings is a great way for a new contributor to learn about the project as well as explore different avenues of contribution. | ||
|
|
||
| ### What if I have an issue that is almost a duplicate, should I open a new one to be triaged? | ||
|
|
||
| You can always open an [issue](https://github.com/opensearch-project/OpenSearch/issues/new/choose) including one that you think may be a duplicate. However, in cases where you believe there is an important distinction to be made between an existing issue and your newly created one, you are encouraged to attend the triage meeting to explain. | ||
|
|
||
| ### What if I have follow-up questions on an issue? | ||
|
|
||
| If you have an existing issue you would like to discuss, you can always comment on the issue itself. Alternatively, you are welcome to come to the triage meeting to discuss. | ||
|
|
||
| ### Is this meeting a good place to get help setting up features on my OpenSearch instance? | ||
|
|
||
| While we are always happy to help the community, the best resource for implementation questions is [the OpenSearch forum](https://forum.opensearch.org/). | ||
|
|
||
| There you can find answers to many common questions as well as speak with implementation experts. | ||
|
|
||
| ### What are the issue labels associated with triaging? | ||
|
|
||
| Yes, there are several labels that are used to identify the 'state' of issues filed in OpenSearch . | ||
| | Label | When applied | Meaning | | ||
| | ----- | ------------ | ------- | | ||
| | Untriaged | When issues are created or re-opened. | Issues labeled as 'Untriaged' require the attention of the repository maintainers and may need to be prioritized for quicker resolution. It's crucial to keep the count of 'Untriaged' labels low to ensure all potential security issues are addressed in a timely manner. See [SECURITY.md](https://github.com/opensearch-project/OpenSearch/blob/main/SECURITY.md) for more details on handling these issues. | | ||
| | Help Wanted | Anytime. | Issues marked as 'Help Wanted' signal that they are actionable and not the current focus of the project maintainers. Community contributions are especially encouraged for these issues. | | ||
| | Good First Issue | Anytime. | Issues labeled as 'Good First Issue' are small in scope and can be resolved with a single pull request. These are recommended starting points for newcomers looking to make their first contributions. | | ||
|
|
||
| ### What kind of outcomes will a triaged issue have? | ||
|
|
||
| | Outcome | Label | Description | Canned Response | | ||
| | ------- | ----- | ----------- | --------------- | | ||
| | Accepted | -`untriaged` | The issue has the details needed to be directed towards area owners. | "Thanks for filing this issue, please feel free to submit a pull request." | | ||
| | Rejected | N/A | The issue will be closed with a reason for why it was rejected. Some reasons will be due to lack of details, or being outside the scope of the project. | "Thanks for creating this issue; however, it isn't being accepted due to {REASON}. Please feel free to re-open after addressing the reason." | | ||
| | Area Triage | +`{AREA-LABEL}` | OpenSearch has many different areas and knowing if an issue should be accepted or not might not be possible with the representatives in the triage meeting, it will be labeled with the area and an owner will be @mentioned to follow up | "Thanks for creating this issue; the triage meeting was unsure if this issue should be accepted, @{PERSON} or someone from the area please review and then accept or reject this issue?" | | ||
| | Transfer | N/A | The issue applies to another repository within the OpenSearch Project | "@opensearch-project/triage can you please transfer this issue to project {REPOSITORY}." Or if someone on the meeting has permissions they can start the transfer | | ||
|
|
||
| ### Is this where I should bring up potential security vulnerabilities? | ||
|
|
||
| Due to the sensitive nature of security vulnerabilities, please report all potential vulnerabilities directly by following the steps outlined on the [SECURITY.md](https://github.com/opensearch-project/OpenSearch/blob/main/SECURITY.md) document. |