From 0c8d8e10acbb5c3e8ee90f850b2fba36a64f45fb Mon Sep 17 00:00:00 2001 From: Rolfe Dlugy-Hegwer Date: Tue, 4 Jun 2024 11:38:17 -0400 Subject: [PATCH] Create REVIEWS.md https://github.com/redhat-documentation/supplementary-style-guide/issues/479 --- REVIEWS.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 REVIEWS.md diff --git a/REVIEWS.md b/REVIEWS.md new file mode 100644 index 00000000..a6dd0846 --- /dev/null +++ b/REVIEWS.md @@ -0,0 +1,57 @@ +## Instructions for PR Authors and Reviewers + +### For PR Authors + +1. **Submit Your PR:** + - Follow the Contributing Guide. + - Add a brief description of the changes. + - Tag relevant reviewers or teams. + +2. **Requesting a Review:** + - Post a review request on the Slack channel or forum as per the project guidelines. + - Mention specific reviewers in your PR description. + +3. **Follow Up on Your PR:** + - If not reviewed within five business days: + - **First Reminder:** Post a polite reminder on the Slack channel or forum. + - **Second Reminder:** Tag the project maintainers or lead contributors in your PR comment. + - **Escalation:** If still pending, send a direct message or email to the project lead. + +4. **Address Feedback Promptly:** + - Promptly address any feedback or requested changes. + - Update your PR description to reflect the changes. + +5. **Merging the PR:** + - Follow the project guidelines for merging. + +### For PR Reviewers + +1. **Respond Promptly:** + - Aim to review PRs within 3-5 business days. + - Communicate your availability to the PR author if needed. + +2. **Provide Constructive Feedback:** + - Give clear and actionable feedback. + - Acknowledge good work and suggest improvements. + +3. **Approve or Request Changes:** + - Approve according to project standards. + - Request changes with detailed explanations. + +4. **Communicate Clearly:** + - Use comments to explain and provide context for your feedback. + - Suggest having additional discussions on the Slack channel or forum if needed. + +5. **Follow Up on Pending Reviews:** + - Inform the PR author if unable to complete a review. + - Keep track of pending reviews and update the PR author on delays. + +### General Guidelines + +- **Respect and Professionalism:** + - Maintain a respectful and professional tone. + - Appreciate the effort and time of all team members. + +- **Collaborative Approach:** + - Work collaboratively for high-quality contributions. + - Encourage open discussions and provide support if needed.