diff --git a/projects/github-actions/repo-gardening/changelog/update-pr-request b/projects/github-actions/repo-gardening/changelog/update-pr-request new file mode 100644 index 0000000000000..da4f49b8a62a9 --- /dev/null +++ b/projects/github-actions/repo-gardening/changelog/update-pr-request @@ -0,0 +1,4 @@ +Significance: patch +Type: changed + +Check PR description: update PR review workflow explanation to have correct markdown indent diff --git a/projects/github-actions/repo-gardening/src/tasks/check-description/index.js b/projects/github-actions/repo-gardening/src/tasks/check-description/index.js index be6e0e85efa8c..5083f92d12ff9 100644 --- a/projects/github-actions/repo-gardening/src/tasks/check-description/index.js +++ b/projects/github-actions/repo-gardening/src/tasks/check-description/index.js @@ -498,15 +498,15 @@ The e2e test report can be found [here](https://automattic.github.io/jetpack-e2e 1. Ensure all required checks appearing at the bottom of this PR are passing. 2. Choose a review path based on your changes: - A. Team Review: add the "[Status] Needs Team Review" label - - For most changes, including minor cross-team impacts. - - Example: Updating a team-specific component or a small change to a shared library. - B. Crew Review: add the "[Status] Needs Review" label - - For significant changes to core functionality. - - Example: Major updates to a shared library or complex features. - C. Both: Start with Team, then request Crew - - For complex changes or when you need extra confidence. - - Example: Refactor affecting multiple systems. + - **A. Team Review:** add the "[Status] Needs Team Review" label + - For most changes, including minor cross-team impacts. + - Example: Updating a team-specific component or a small change to a shared library. + - **B. Crew Review:** add the "[Status] Needs Review" label + - For significant changes to core functionality. + - Example: Major updates to a shared library or complex features. + - **C. Both:** Start with Team, then request Crew + - For complex changes or when you need extra confidence. + - Example: Refactor affecting multiple systems. 3. Get at least one approval before merging. Still unsure? Reach out in #jetpack-developers for guidance!`;