Browse Source

Apply suggestions from code review

Co-authored-by: chanmosq <[email protected]>
Signed-off-by: Stephen Tramer <[email protected]>
Stephen Tramer 2 years ago
parent
commit
3540ff7ae7

+ 9 - 7
.github/ISSUE_TEMPLATE/docs-reviewer-nomination.yaml

@@ -15,18 +15,19 @@ body:
 
 
         **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.
         **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 on the general requirements of Reviewer roles, read our [Community Membership](https://github.com/o3de/community/blob/main/community-membership.md) information.
+        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
   - type: input
     id: username
     id: username
     attributes:
     attributes:
-      label: Nominee GitHub user name
+      label: Nominee's GitHub username
       placeholder: username
       placeholder: username
     validations:
     validations:
       required: true
       required: true
   - type: textarea
   - type: textarea
     id: evidence
     id: evidence
     attributes:
     attributes:
-      label: Link to relevant pull requests or comments that demonstrate meeting the requirements.
+      label: Relevant experience
+      description: Link to relevant pull requests or comments that demonstrate meeting the requirements.
       placeholder: |
       placeholder: |
         * <links to relevant pull requests or comments>
         * <links to relevant pull requests or comments>
         * ...
         * ...
@@ -40,12 +41,13 @@ body:
   - type: checkboxes
   - type: checkboxes
     id: approvals
     id: approvals
     attributes:
     attributes:
-      label: '**BOXES TO BE CHECKED NOMINATION REVIEW**'
+      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:
       options:
         - label: |
         - label: |
           6+ merged documentation contributions for the O3DE project. The following count as documentation contributions:
           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 sig-docs-community non-technical review group.
+          * 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.
           * 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 documentation reviewer.
-        - label: 2+ docs or community reviewers or Maintainers of the Documentation and Community SIG approve the nomination.
+          * 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.

+ 9 - 8
.github/ISSUE_TEMPLATE/maintainer-nomination.yaml

@@ -1,5 +1,5 @@
 name: Maintainer Nomination Template
 name: Maintainer Nomination Template
-description: Nominate yourself or someone else as a Documentaty & Community SIG maintainer.
+description: Nominate yourself or someone else as a Documentation & Community SIG maintainer.
 title: 'SIG Maintainer Nomination: <username>'
 title: 'SIG Maintainer Nomination: <username>'
 labels: nomination/sig-maintainer
 labels: nomination/sig-maintainer
 body:
 body:
@@ -18,22 +18,22 @@ body:
         * Serve in more than one reviewer group for the SIG.
         * Serve in more than one reviewer group for the SIG.
         * Attend SIG meetings and triages.
         * Attend SIG meetings and triages.
 
 
-        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.
+        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. 
         **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. 
 
 
-        *Supporters of this nomination should comment in this issue.*
   - type: input
   - type: input
     id: username
     id: username
     attributes:
     attributes:
-      label: Nominee GitHub user name
+      label: Nominee's GitHub username
       placeholder: username
       placeholder: username
     validations:
     validations:
       required: true
       required: true
   - type: textarea
   - type: textarea
     id: evidence
     id: evidence
     attributes:
     attributes:
-      label: Link to relevant pull requests or comments that demonstrate meeting the requirements.
+      label: Relevant experience
+      description: Link to relevant pull requests or comments that demonstrate meeting the requirements.
       placeholder: |
       placeholder: |
         * <links to relevant pull requests or comments>
         * <links to relevant pull requests or comments>
         * ...
         * ...
@@ -43,15 +43,16 @@ body:
     id: information
     id: information
     attributes:
     attributes:
       label: Support statement 
       label: Support statement 
-      description: Include a brief statement about why you support this nomination. For maintainer nominations, this is not optional.
+      description: Include a brief statement about why you support this nomination. For maintainer nominations, this is required.
     validations:
     validations:
       required: true
       required: true
   - type: checkboxes
   - type: checkboxes
     id: approvals
     id: approvals
     attributes:
     attributes:
-      label: '**BOXES TO BE CHECKED NOMINATION REVIEW**'
+      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:
       options:
-        - label: Has been a Reviewer for the SIG (docs, community, or website) for 2+ months.
+        - 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: 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.
         - label: 2+ Documentation and Community SIG Maintainers who support promotion. In the absence of enough maintainers, chairs will promote.