diff --git a/changelog.d/6396.doc b/changelog.d/6396.doc new file mode 100644 index 0000000000..9b876d74af --- /dev/null +++ b/changelog.d/6396.doc @@ -0,0 +1 @@ +Update the PR process doc to come back to one reviewer with optional additional reviewers. \ No newline at end of file diff --git a/docs/pull_request.md b/docs/pull_request.md index d2d2bb7a3b..eebf2814a9 100644 --- a/docs/pull_request.md +++ b/docs/pull_request.md @@ -83,15 +83,16 @@ Exceptions can occur: ##### PR Review Assignment -We use automatic assignment for PR reviews. A PR is automatically routed by GitHub to 2 team members using the round robin algorithm. The process is the following: +We use automatic assignment for PR reviews. **A PR is automatically routed by GitHub to one team member** using the round robin algorithm. Additional reviewers can be used for complex changes or when the first reviewer is not confident enough on the changes. +The process is the following: -- The PR creator can assign specific people if they have another Android developer in their team or they think a specific reviewer should take a look at the PR. -- If there are missing reviewers, the PR creator assigns the [element-android-reviewers](https://github.com/orgs/vector-im/teams/element-android-reviewers) team as a reviewer. -- GitHub automatically assigns other reviewers. If one of the chosen reviewers is not available (holiday, etc.), remove them and set again the team, GitHub will select another reviewer. +- The PR creator selects the [element-android-reviewers](https://github.com/orgs/vector-im/teams/element-android-reviewers) team as a reviewer. +- GitHub automatically assign the reviewer. If the reviewer is not available (holiday, etc.), remove them and set again the team, GitHub will select another reviewer. +- Alternatively, the PR creator can directly assign specific people if they have another Android developer in their team or they think a specific reviewer should take a look at their PR. - Reviewers get a notification to make the review: they review the code following the good practice (see the rest of this document). - After making their own review, if they feel not confident enough, they can ask another person for a full review, or they can tag someone within a PR comment to check specific lines. -For PRs coming from the community, the issue wrangler can assign either the team [element-android-reviewers](https://github.com/orgs/vector-im/teams/element-android-reviewers) or any members directly. +For PRs coming from the community, the issue wrangler can assign either the team [element-android-reviewers](https://github.com/orgs/vector-im/teams/element-android-reviewers) or any member directly. ##### PR review time @@ -102,6 +103,7 @@ Some tips to achieve it: - Set up your GH notifications correctly - Check your pulls page: [https://github.com/pulls](https://github.com/pulls) - Check your pending assigned PRs before starting or resuming your day to day tasks +- If you are busy with high priority tasks, inform the author. They will find another developer It is hard to define a deadline for a review. It depends on the PR size and the complexity. Let's start with a goal of 24h (working day!) for a PR smaller than 500 lines. If bigger, the submitter and the reviewer should discuss.