Repo gardening: update PR review flow explanation to be clearer (#38881)

* Repo gardening: update PR review flow explanation to be clearer Related conversation: p1723620319635249/1723563375.969809-slack-C4GAQ900P * Add link around labels * Remove link on labels I expected it to auto-format as mentioned in some discussions on GitHub, but that doesn't work on my tests.
Automattic · Aug 14, 2024 · 14e9ea8 · 14e9ea8
1 parent ee639f8
commit 14e9ea8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/projects/github-actions/repo-gardening/changelog/update-description-pr-flow-message b/projects/github-actions/repo-gardening/changelog/update-description-pr-flow-message
@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Check PR description: update PR review workflow explanation to be clearer.
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
@@ -494,9 +494,22 @@ The e2e test report can be found [here](https://automattic.github.io/jetpack-e2e
 	if ( statusChecks.isFromContributor ) {
 		comment += `
 
-Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
-Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
-If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.`;
+**Follow this PR Review Process:**
+
+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.
+3. Get at least one approval before merging.
+
+Still unsure? Reach out in #jetpack-developers for guidance!`;
 	}
 
 	// Gather info about the next release for that plugin.