Browse Source

Merge pull request #77 from sptramer/rfc61/docs-reviewer-maintainer

Update docs-reviewer and SIG maintainer nominations. [RELATED #61]
chanmosq 2 years ago
parent
commit
9f54ea6869

+ 52 - 0
.github/ISSUE_TEMPLATE/docs-reviewer-nomination.yaml

@@ -0,0 +1,52 @@
+name: Docs Reviewer Nomination Template
+description: Nominate yourself or someone else to become a documentation reviewer.
+title: 'Documentation Reviewer Nomination: <username>'
+labels: nomination/docs-reviewer
+body:
+  - type: markdown
+    attributes:
+      value: |
+        The Documentation and Community SIG maintains several reviewer roles requiring SIG approval - this nomination form is for serving as a _documentation reviewer_, responsible for reviewing contributions to `o3de.org/docs`. Documentation reviewers are expected to:
+
+        * Help guide structure and intent of documentation submissions. Writing documentation is hard and often a subjective exercise, so reviewers are expected to exercise both their best judgement and follow common site structure and [templates](https://www.o3de.org/docs/contributing/to-docs/templates/) where available.
+        * Help ensure consistency of product [terminology](https://www.o3de.org/docs/contributing/to-docs/terminology/).
+        * Review content submissions with an eye towards following the [style guide](https://www.o3de.org/docs/contributing/to-docs/style-guide/).
+
+        **Maintaining status:** 4+ Pull Requests reviewed per month, or as-assigned. Under light PR load, these requirements are relaxed. Not meeting this requirement for two months in a row results in loss of reviewer status.
+
+        For more information, read our SIG's [Documentation and Community reviewer roles](https://github.com/o3de/sig-docs-community/blob/main/governance/reviewers-maintainers.md). For general information about the O3DE community's Reviewer roles, read our [Community Membership](https://github.com/o3de/community/blob/main/community-membership.md#reviewers).
+  - type: input
+    id: username
+    attributes:
+      label: Nominee's GitHub username
+      placeholder: username
+    validations:
+      required: true
+  - type: textarea
+    id: evidence
+    attributes:
+      label: Relevant experience
+      description: Link to relevant pull requests or comments that demonstrate meeting the requirements.
+      placeholder: |
+        * <links to relevant pull requests or comments>
+        * ...
+    validations:
+      required: true
+  - type: textarea
+    id: information
+    attributes:
+      label: Support statement  (Optional)
+      description: If you'd like, include a brief statement about why you support this nomination.
+  - type: checkboxes
+    id: approvals
+    attributes:
+      label: Nomination Review Checklist
+      description: Leave this empty. This checklist will be filled in by a sig-docs-community member who is reviewing the nomination.
+      options:
+        - label: |
+          6+ merged documentation contributions for the O3DE project. The following count as documentation contributions:
+          
+          * Contributions to any section of https://o3de.org/docs requiring review by a member of the [sig-docs-community-review](https://github.com/orgs/o3de/teams/sig-docs-community-reviewers) team.
+          * Contributions to accepted sig-docs-community RFCs related to documentation. This may include operational support as well as technical writing.
+          * High-quality error messages, tooltips, UI text, or API documentation submitted to https://github.com/o3de/o3de involving approval of at least one member of the [docs-reviewer](https://github.com/orgs/o3de/teams/docs-reviewers) team.
+        - label: 2+ docs or community reviewers or maintainers of the Documentation and Community SIG approve the nomination.

+ 59 - 0
.github/ISSUE_TEMPLATE/maintainer-nomination.yaml

@@ -0,0 +1,59 @@
+name: Maintainer Nomination Template
+description: Nominate yourself or someone else as a Documentation & Community SIG maintainer.
+title: 'SIG Maintainer Nomination: <username>'
+labels: nomination/sig-maintainer
+body:
+  - type: markdown
+    attributes:
+      value: |
+        The Documentation and Community SIG maintains several reviewer roles requiring SIG approval - this nomination form is for serving as a _sig-docs-community maintainer_, responsible for reviewing contributions to `o3de.org/docs`. Maintainers are expected to:
+
+        * Serve as a "trusted reviewer", who has shown continued excellence in their contributions to the SIG - whether as a reviewer, contributor, or through participation in SIG events.
+        * 8+ Pull Requests reviewed per month. Not meeting this requirement results in reduction to Reviewer status.
+
+        Maintainers have no extra roles or responsibilities - they effectively serve as our _most trusted reviewers_ who
+        have shown dedication to the SIG and quality work. Maintainers are _encouraged_ to:
+
+        * Participate regularly in sig-docs-community RFCs, or other O3DE project RFCs needing comments from sig-docs-community.
+        * Serve in more than one reviewer group for the SIG.
+        * Attend SIG meetings and triages.
+
+        For more information, read our SIG's [Documentation and Community reviewer roles](https://github.com/o3de/sig-docs-community/blob/main/governance/reviewers-maintainers.md). For general information about the O3DE community's Reviewer roles, read our [Community Membership](https://github.com/o3de/community/blob/main/community-membership.md#maintainers).
+        
+        **Maintaining status:** 8+ Pull Requests reviewed per month. Not meeting this requirement results in reduction to Reviewer status. Maintainers are encouraged to attend SIG triage and other regular meetings, but are not required to. 
+
+  - type: input
+    id: username
+    attributes:
+      label: Nominee's GitHub username
+      placeholder: username
+    validations:
+      required: true
+  - type: textarea
+    id: evidence
+    attributes:
+      label: Relevant experience
+      description: Link to relevant pull requests or comments that demonstrate meeting the requirements.
+      placeholder: |
+        * <links to relevant pull requests or comments>
+        * ...
+    validations:
+      required: true
+  - type: textarea
+    id: information
+    attributes:
+      label: Support statement 
+      description: Include a brief statement about why you support this nomination. For maintainer nominations, this is required.
+    validations:
+      required: true
+  - type: checkboxes
+    id: approvals
+    attributes:
+      label: Nomination Review Checklist
+      description: Leave this empty. This checklist will be filled in by a sig-docs-community member who is reviewing the nomination.
+      options:
+        - label: Has been a Reviewer for the SIG ([docs-reviewer](https://github.com/orgs/o3de/teams/docs-reviewers), community-reviewer, or website-reviewer) for 2+ months.
+        - label: 12+ reviewed Pull Requests in the previous 2 months. Under light PR load, has been a reviewer for a minimum of 3 months.
+        - label: 2+ Documentation and Community SIG Maintainers who support promotion. In the absence of enough maintainers, chairs will promote.
+
+

+ 0 - 56
.github/ISSUE_TEMPLATE/reviewer-maintainer-nomination.md

@@ -1,56 +0,0 @@
----
-name: SIG Reviewer/Maintainer Nomination Template
-about: Nominate yourself or someone else to become a SIG reviewer or maintainer
-title: 'SIG Reviewer/Maintainer Nomination'
----
-
-The Documentation and Community SIG maintains several reviewer roles requiring SIG approval:
-
-* **Documentation reviewer** - Documentation reviewers review for conformance with the [style guide](https://o3de.org/docs/contributing/to-docs/style-guide/), appropriateness of content, and other subjective factors to keep documentation content aligned.
-* **Technical reviewer** - Technical reviewers review documentation for technical accuracy: They make sure that described steps, features, file formats, code examples, and other parts of documentation that are deeply technical match the _current_ product state.
-
-Any individual can be a member of multiple reviewer or maintainer roles within this SIG!
-
-For more on the general requirements of Reviewer and Maintainer roles, read our [Community Membership](https://github.com/o3de/community/blob/main/community-membership.md) information.
-
-----
-<!-- CUT ABOVE THIS LINE BEFORE POSTING -->
-### Nomination Guidelines
-
-#### Documentation reviewer
-
-* [ ] 6+ documentation contributions merged to o3de.org or O3DE. The following count as documentation contributions:
-  * Contributions to the Atom Guide, User Guide, Welcome Guide, or Tutorials sections of https://o3de.org/docs
-  * High-quality error messages, tooltips, UX text, or API documentation submitted to https://github.com/o3de/o3de involving approval of
-    at least one sig-docs-community reviewer.
-* [ ] 2+ Reviewers or Maintainers of the Documentation and Community SIG approve the nomination.
-
-**Maintaining status:** 4+ Pull Requests reviewed per month, or as-assigned. Light loads of PRs relax these requirements.
-
-#### Technical reviewer
-
-* [ ] Is a Reviewer or Maintainer for a SIG governing the appropriate technology.
-* [ ] 1+ of the appropriate SIG's Reviewers or Maintainers who support the promotion.
-* [ ] 1+ Reviewers or Maintainers of the Documentation and Community SIG who support the promotion.
-
-**Maintaining status:** Serve in the technical review rotation for your SIG as required by their available pool of reviewers.
-
-#### Documentation maintainer
-
-* [ ] Has been a Reviewer for 2+ months
-* [ ] 12+ reviewed Pull Requests in the previous 2 months (exceptions may be made during periods of light load)
-* [ ] 2+ Documentation and Community SIG Maintainers who support promotion. In the absence of enough maintainers, chairs will promote.
-
-**Maintaining status:** 8+ Pull Requests reviewed per month. Maintainers are encouraged to attend SIG triage and other regular meetings.
-
--------
-### Reviewer/Maintainer Nomination
-
-##### Fill out the template below including nominee GitHub user name, desired role and personal GitHub profile
--------------------
-
-I would like to nominate: ***<GitHub User Name>***, to become a ***<Docs Reviewer|Technical Reviewer|Maintainer>*** on behalf of ***sig-<SIG Name>***. I verify that they have fulfilled the prerequisites for this role.
-
-* Nominee's GitHub Profile ***< https://github.com/ githubsername >***
-
-*Reviewers & Maintainers that support this nomination should comment in this issue.*