diff --git a/REVIEWING.md b/REVIEWING.md index fc81f57..b93a533 100644 --- a/REVIEWING.md +++ b/REVIEWING.md @@ -8,6 +8,11 @@ As a reviewer, you will make sure that questions are of good quality: You will also need to have a good overview of existing questions in the repository to prevent duplicates. +## Table of contents +- [Working on Pull Requests](#working-on-pull-requests) +- [Reviewing public pool repo contribution](#reviewing-public-pool-repo-contribution) +- [Reviewing private pool repo contribution](#reviewing-private-pool-repo-contribution) + ## Working on Pull Requests You will review contributions as pull requests. @@ -20,3 +25,38 @@ Question formatting will be validated automatically through the use of a GitHub Add your review as comments and request for changes to the PR until everything is ready to be approved. Then approve the PR. Once approved, either you or someone with proper access rights can use `Rebase and merge` to merge the PR commits and integrate the contribution. + +## Reviewing public pool repo contribution + +Starting: There is a pending contribution to the public pool + +Workflow: +* The reviewer goes through the pending contribution +* The reviewer checks the questions' relevance, format, metadata, whether they are different from the existing questions, while following the Reviewing guidelines +* If needed, the reviewer gives feedback and requests changes + +Result: +* The contribution is accepted and integrated in the public pool repo +* The contribution needs updates according to the feedback +* The contribution is rejected, for one of these reasons: + * The question is irrelevant, incorrect or unfixable + * The question already exists in the public pool repo + * The question already exists in the private pool repo + + +## Reviewing private pool repo contribution + +Starting: There is a pending contribution to the private pool + +Workflow: +* The reviewer goes through the pending contribution +* The reviewer checks the questions' relevance, format, metadata, whether they are different from the existing questions, while following the Reviewing guidelines +* If needed, the reviewer gives feedback and requests changes + +Result: +* The contribution is accepted and integrated in the private pool repo +* The contribution needs updates according to the feedback +* The contribution is rejected, for one of these reasons: + * The question is irrelevant, incorrect or unfixable + * The question already exists in the public pool repo + * The question already exists in the private pool repo