Peer reviews allow members of your team to comment on Project branches and suggest whether the changes should move forward or not.
If peer reviews are required, branches created from your Project can only be transformed into pull requests if another member of the team approves the changes.
Reviews can be added to any Project branch for all Spaces on a Team or Enterprise plan.
If a reviewer is manually added to a Project branch, they receive an email requesting their review.
To approve, comment, or request changes to a Project branch as a reviewer:
- Navigate to the Project branch where you have been assigned as a reviewer.
- Review the changes as requested.
- Click the Review button.
- Enter your comments and choose Approve, Comment only, or Request changes.
- Click Submit review.
To require peer reviews:
- Go to a Project's settings by clicking the three-dot menu after hovering over a Project.
- Go to the Permissions tab.
- Toggle the option next to Require Approval Before PR.
- Click Save.
After completing these steps, pull requests are disabled until another member of the team approves the changes.
Spaces on an Enterprise plan may enable a requirement for specific roles to approve changes before a pull request is made. To require specific roles to approve:
- Go to a Project's settings by clicking the three-dot menu after hovering over a Project.
- Go to the Permissions tab.
- Toggle the option next to Require Approval Before PR.
- Choose which roles must approve of the changes before a pull request is made.
- Click Save.
For each role selected, a different reviewer must approve. For example, if the Editor and Designer roles are selected, a member with the Editor role and a member with the Designer role must approve of the changes.
Once changes have been made on a Project's branch, you can request reviewers by role or by name.
Within a Project branch, click the Review button to request a Project review. You can then add a reviewer by role or by name.
If you a select a role comprised of multiple members, a random member is assigned.
For example, imagine three members of your team are assigned the Designer role. If the Designer role is requested to review, one of those three members is randomly assigned and must approve of the changes before a pull request can be sent.
If reviewers from more than one role are required, use the Auto Assign button to automatically assign one of each role to your Project branch.
You can always still manually remove and add specific reviewers as needed.
Add a branch description so that your reviewers have a clear idea on what they should review.
To add a branch description:
- Click the Review button on your Project branch.
- Click the Add button next to the text Branch Description.
- Add your description within the provided text field.
- Click Save.
Branch descriptions can be added before or after reviewers have been added.