Skip to content

Commit

Permalink
Create REVIEWS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rolfedh committed Jun 4, 2024
1 parent 1fa2637 commit 0c8d8e1
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions REVIEWS.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 0c8d8e1

Please sign in to comment.