Updated MAINTAINERS.md to match recommended opensearch-project format. (

#3046) Signed-off-by: dblock <[email protected]> Signed-off-by: dblock <[email protected]>
opensearch-project · Jan 5, 2023 · ca5e189 · ca5e189
1 parent f6d5874
commit ca5e189
Showing 1 changed file with 19 additions and 13 deletions.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -1,6 +1,5 @@
-<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>
-
-- [Maintainers](#maintainers)
+- [Overview](#overview)
+- [Current Maintainers](#current-maintainers)
 - [Release Owner](#release-owner)
   - [Release Activities](#release-activities)
   - [Dealing with Ambiguity](#dealing-with-ambiguity)
@@ -20,7 +19,11 @@
   - [Recurring Team Meetings](#recurring-team-meetings)
   - [On-Call](#on-call)
 
-## Maintainers
+## Overview
+
+This document contains a list of maintainers in this repo. See [opensearch-project/.github/RESPONSIBILITIES.md](https://github.com/opensearch-project/.github/blob/main/RESPONSIBILITIES.md#maintainer-responsibilities) that explains what the role of maintainer means, what maintainers do in this and other repos, and how they should be doing it. If you're interested in contributing, and becoming a maintainer, see [CONTRIBUTING](CONTRIBUTING.md).
+
+## Current Maintainers
 
 | Maintainer       | GitHub ID                                           | Affiliation |
 | ---------------- | --------------------------------------------------- | ----------- |
@@ -29,41 +32,46 @@
 | Sayali Gaikawad  | [gaiksaya](https://github.com/gaiksaya)             | Amazon      |
 | Rishab Singh     | [rishabh6788](https://github.com/rishabh6788)       | Amazon      |
 | Zelin Hao        | [zelinh](https://github.com/zelinh)                 | Amazon      |
-| Prudhvi Godithi  | [prudhvigodithi](https://github.com/prudhvigodithi) | Amazon       | 
-
-
-[This document](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md) explains what maintainers do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).
+| Prudhvi Godithi  | [prudhvigodithi](https://github.com/prudhvigodithi) | Amazon      |
 
 ## Release Owner
-The release owner is a temporary role for the duration of a given OpenSearch / OpenSearch Dashboards release.  This owner is tracked by the assignment of a release ticket an individual.  The release owner oversees the release ticket, makes sure the activities are completed, and closed the release.  Release activities are documented in the release ticket, see the [template](./.github/ISSUE_TEMPLATE/release_template.md). The purpose of the release owner is to be responsible for following the release process.
+
+The release owner is a temporary role for the duration of a given OpenSearch / OpenSearch Dashboards release.  This owner is tracked by the assignment of a release ticket an individual. The release owner oversees the release ticket, makes sure the activities are completed, and closed the release.  Release activities are documented in the release ticket, see the [template](./.github/ISSUE_TEMPLATE/release_template.md). The purpose of the release owner is to be responsible for following the release process.
 
 ### Release Activities
+
 The release owner performs the activities described in the overall release ticket.  Other activities associated with the release are managed by the component release owners or are be delegation to the most appropriate area owner.  Keeping the release owner's activities well document and predicable ensures the release process avoids bottlenecks.
 
 ### Dealing with Ambiguity 
+
 Tasks will become unclear to complete, the release owner’s role is to make sure that a path to resolution is found by involving those that are needed and communicating via the primary release issue and on the component release issues.
 
 ### Managing Critical Issues
+
 Create a new issue in GitHub any time the release schedule is impacted.  For transparency GitHub has all the information pertaining to state of the release.
 
 #### General Guidelines
+
 - For issues impacting a single component, created an issue in the component’s GitHub repository, with the release version tag and referenced on the component's release issue.
 - For issues impacting multiple components, create an issue in the root cause's GitHub repository, with the release version tag and referenced in the component's release issues.
 - For issues impacting all / blocking any productivity, create an issue immediately in this repository, with the release version tag, and post a comment in the general release ticket.  Make a broad call to action for stakeholders to engage in the issue.  Closely monitor the issue until the release can resume as planned.
 
 ### Correcting Mistakes
+
 Mistakes happen, correcting these transparently is paramount.  Use markdown strike-through when making edits to correct incorrect information instead of deleting. 
 
 Some mistakes are larger, such as a process that was marked completed was done so incorrectly, these corrections need additional tracking as a campaign. Create an issue to drive the campaign with a list of components to track statuses such as notifications and confirmation of the correction.  This is important to confirm that the process was completed as expected, see an [example](https://github.com/opensearch-project/opensearch-build/issues/954).
 
 ### Retrospectives
+
 The release process will be improved and invested in, running a retrospective and communicating an summary of its results is necessary to achieve this.  Retrospectives are encouraged at the component level in the component release issues template. 
 
 Feedback comes from the retro issue created during the release and component level retrospectives.  A meeting could be run to capture additional feedback if desired.  This process is focused on recording what happened to make remedies.
 
 After the retro items are in, a final summary is written as a comment on the retrospective issue.  The comment includes areas of consideration for the project alongside action items with owners to drive them, [example](https://github.com/opensearch-project/opensearch-build/issues/880) summary.
 
 ## ZenHub Process Workflow
+
 We follow agile methodologies for our development and release process. We use GitHub issues with annotations via ZenHub to manage and track our stories and issues to effectively manage them over the sprint.
 
 ### What is [ZenHub](https://www.zenhub.com/)?
@@ -77,6 +85,7 @@ ZenHub can be easily added as an [extension]((https://www.zenhub.com/extension))
 Alternatively, we can use a the ZenHub [webapp link](https://app.zenhub.com/workspaces/engineering-effectiveness-614cf4272a385f0015d2b48f/board?repos=357723952,406037663) to view the board.
 
 ### Sprint Board
+
 Once the ZenHub extension is installed, ZenHub board can be accessed using the ZenHub tab on GitHub.
 
 ![img.png](zenhub_tab_image.png)
@@ -139,15 +148,12 @@ This would ensure that all the tasks the an individual is working on is correctl
 
   Everyone should spend approximately 1 minute to discuss the work without interruption, answering questions like - What did I do yesterday? What is the plan for today? What help I might need from others? After everyone turns, we can discuss go-backs if any. The Moderator keeps track of the time.
 
-
 - **Grooming -** All team members come together to add items to the Product Backlog.  These issues/stories should have been reviewed, estimated, and prioritized top-to-bottom.
 
-
 - **Planning -** We go over the product backlog to see what all do we need to complete for the current sprint.
 
-
 - **Retrospective -** This meeting is held at the end of a sprint used to discuss what went well during the previous sprint cycle and what can be improved for the next sprint.
 
 ### On-Call
-Since on-call is a weekly rotation, we do not create an issue for on-call. However, if on-call requires you to work on a bug, please make sure that we have issue associated with the task for tracking.
 
+Since on-call is a weekly rotation, we do not create an issue for on-call. However, if on-call requires you to work on a bug, please make sure that we have issue associated with the task for tracking.