Skip to content

Commit 2d82ef7

Browse files
lrapoport-cfmrbbot
andauthored
Add instruction about highlight pr review (#3682)
Co-authored-by: MrBBot <[email protected]>
1 parent ade600c commit 2d82ef7

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.github/pull_request_template.md

+4
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,7 @@ Fixes # [insert GH or internal issue number(s)].
1717
- Checked for inclusion of a relevant changeset
1818
- Checked for creation of associated docs updates
1919
- Manually pulled down the changes and spot-tested
20+
21+
**Note for PR author:**
22+
23+
We want to celebrate and highlight awesome PR review! If you think this PR received a particularly high-caliber review, please assign it the label `highlight pr review` so future reviewers can take inspiration and learn from it.

CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,12 @@ Changes should be committed to a new local branch, which then gets pushed to you
195195
- The format for Pull Request titles is `[package name] description`, where the package name should indicate which package of the `workers-sdk` monorepo your PR pertains to (e.g. `wrangler`/`pages-shared`/`wrangler-devtools`), and the description should be a succinct summary of the change you're making.
196196
- GitHub will insert a template for the body of your Pull Request—it's important to carefully fill out all the fields, giving as much detail as possible to reviewers.
197197

198+
## PR Review
199+
200+
PR review is a critial and required step in the process for landing changes. This is an opportunity to catch potential issues, improve the quality of the work, celebrate good design, and learn from each other.
201+
202+
As a reviewer, it's important to be thoughtful about the proposed changes and communicate any feedback. Examples of PR reviews that the community has identified as particularly high-caliber are labeled with the `highlight pr review` label. Please feel empowered to use these as a learning resource.
203+
198204
## Changesets
199205

200206
Every non-trivial change to the project - those that should appear in the changelog - must be captured in a "changeset".

0 commit comments

Comments
 (0)