diff --git a/.github/workflows/pr-checklist.yml b/.github/workflows/pr-checklist.yml index 83705f9efa..c0de7db3ee 100644 --- a/.github/workflows/pr-checklist.yml +++ b/.github/workflows/pr-checklist.yml @@ -15,12 +15,19 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} issue-number: ${{ github.event.pull_request.number }} body: | - Thank you for submitting your PR. The PR states are Tech review -> Doc review -> Editorial review. If you're a developer submitting documentation for a feature you implemented, have the documentation reviewed by your team. If you need a tech review, let us know. Here's a checklist of the PR progression: + Thank you for submitting your PR. The PR states are Tech review -> Doc review -> Editorial review. Here's a checklist of the PR progression: - ### PR Checklist - - [x] Tech Review - - [ ] Doc Review - - [ ] Editorial Review + ### PR checklist + - [] Tech review: + - If you're a developer submitting documentation for a feature you implemented, you can skip this step. + - If you need a tech review, tag @kolchfa-aws. + - Tech reviewer: Tag @kolchfa-aws once the tech review is done. + - [ ] Doc review: A doc reviewer may: + - Leave comments/suggestions: You will implement comments and add suggestions to batch and commit the batch as one commit. + - Edit the PR: The doc reviewer will push edits to this PR directly (let us know if you don't want this option). + - [ ] Editorial review: The doc reviewer will put the PR through editorial review. + + Please be available to answer questions. Thank you! - name: Add assignees to the PR uses: peter-evans/create-or-update-comment@v3