docs-tech-review-template.yaml 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. name: 'SIG-<SIG-NAME>: Documentation Technical Reviewer Nomination'
  2. description: Nominate yourself or someone else to become a documentation reviewer on behalf of <SIG NAME> for technical accuracy.
  3. title: '<SIG-NAME> Documentation Technical Reviewer Nomination: <username>'
  4. body:
  5. - type: markdown
  6. attributes:
  7. value: |
  8. In conjunction with sig-docs-community, each technical SIG has its own reviewer pool to ensure accurate documentation. This nomination form
  9. is to become a _documentation technical reviewer_ on behalf of <SIG NAME>, responsible for reviewing documentation contributions to `o3de.org`
  10. for technical correctness. Documentation technical reviewers are expected to:
  11. * Assist in the review of `o3de.org` content for technical accuracy
  12. * <Your SIG may add any additional specialized requirements for review.>
  13. **Maintaing status:** <Each SIG is required to set their own standards for maintaining status, depending on the size of their reviewer pool and feature velocity. Be aware that without technical reviewers, the Documentation and Community SIG cannot merge documentation under [RFC #61](https://github.com/o3de/sig-docs-community/issues/61) and [RFC #74](https://github.com/o3de/sig-docs-community/issues/74).>
  14. For more on the general requirements of Reviewer roles, read our [Community Membership](https://github.com/o3de/community/blob/main/community-membership.md) information.
  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: Is a Reviewer or Maintainer for <SIG NAME>.
  44. - label: 1+ of <SIG NAME> Reviewers or Maintainers support the promotion.
  45. - label: 1+ Reviewers or Maintainers of the Documentation and Community SIG support the promotion.