docs-reviewer-nomination.yaml 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. name: Docs Reviewer Nomination Template
  2. description: Nominate yourself or someone else to become a documentation reviewer.
  3. title: 'Documentation Reviewer Nomination: <username>'
  4. labels: nomination/docs-reviewer
  5. body:
  6. - type: markdown
  7. attributes:
  8. value: |
  9. 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:
  10. * 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.
  11. * Help ensure consistency of product [terminology](https://www.o3de.org/docs/contributing/to-docs/terminology/).
  12. * Review content submissions with an eye towards following the [style guide](https://www.o3de.org/docs/contributing/to-docs/style-guide/).
  13. **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.
  14. 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).
  15. - type: input
  16. id: username
  17. attributes:
  18. label: Nominee's GitHub username
  19. placeholder: username
  20. validations:
  21. required: true
  22. - type: textarea
  23. id: evidence
  24. attributes:
  25. label: Relevant experience
  26. description: Link to relevant pull requests or comments that demonstrate meeting the requirements.
  27. placeholder: |
  28. * <links to relevant pull requests or comments>
  29. * ...
  30. validations:
  31. required: true
  32. - type: textarea
  33. id: information
  34. attributes:
  35. label: Support statement (Optional)
  36. description: If you'd like, include a brief statement about why you support this nomination.
  37. - type: checkboxes
  38. id: approvals
  39. attributes:
  40. label: Nomination Review Checklist
  41. description: Leave this empty. This checklist will be filled in by a sig-docs-community member who is reviewing the nomination.
  42. options:
  43. - label: |
  44. 6+ merged documentation contributions for the O3DE project. The following count as documentation contributions:
  45. * 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.
  46. * Contributions to accepted sig-docs-community RFCs related to documentation. This may include operational support as well as technical writing.
  47. * 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.
  48. - label: 2+ docs or community reviewers or maintainers of the Documentation and Community SIG approve the nomination.