Peer Review Protocol¶
To enhance clarity among contributors and facilitate effective peer reviews, we adhere to a standardized peer review process as a team. This process involves the following steps:
- Implement the entire or partial feature/fix on the designated branches.
- Ensure that the CI pipelines pass after pushing changes to the remote branch.
- Create a pull request to the main branch, ensuring there are no code conflicts.
- Notify team members of the new pull request in the team channel.
- Any available team member for peer review should acknowledge by reacting with an
eye emoji (👀)
in the channel thread. - The reviewer provides feedback on the pull request using the GitHub UI or initiates a discussion within the channel thread.
- If there are comments on the pull request, the reviewer may react to the thread with a
pencil emoji (✏️)
. - Once the reviewer is satisfied with the pull request, or if changes have been made following the initial review, they should react to the thread with a
thumbs-up emoji (👍)
. - After the pull request is approved, the writer can merge the pull request and subsequently delete the branch unless there is no further changes.