Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Reviewing workflow to REVIEWING.md #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions REVIEWING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Table of contents
## 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.
Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Reviewing public pool repo contribution
## Reviewing public pool repository contribution


<b>Starting</b>: There is a pending contribution to the public pool
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<b>Starting</b>: There is a pending contribution to the public pool
**Starting**: There is a pending contribution to the public pool


<b>Workflow</b>:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<b>Workflow</b>:
**Workflow**:

* The reviewer goes through the pending contribution
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The reviewer goes through the pending contribution
* 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The reviewer checks the questions' relevance, format, metadata, whether they are different from the existing questions, while following the Reviewing guidelines
* The reviewer checks the questions' relevance, format, metadata, whether they are different from the existing questions, while following these guidelines.

* If needed, the reviewer gives feedback and requests changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* If needed, the reviewer gives feedback and requests changes
* If needed, the reviewer gives feedback and requests changes.


<b>Result</b>:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<b>Result</b>:
**Result**:

* The contribution is accepted and integrated in the public pool repo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The contribution is accepted and integrated in the public pool repo
* The contribution is accepted and integrated in the public pool repository.

* The contribution needs updates according to the feedback
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The contribution needs updates according to the feedback
* The contribution needs updates according to the feedback.

* The contribution is rejected, for one of these reasons:
* The question is irrelevant, incorrect or unfixable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The question is irrelevant, incorrect or unfixable
* The question is irrelevant, incorrect or unfixable.

* The question already exists in the public pool repo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The question already exists in the public pool repo
* The question already exists in the public pool repository.

* The question already exists in the private pool repo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The question already exists in the private pool repo
* The question already exists in the private pool repository.



## Reviewing private pool repo contribution
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Reviewing private pool repo contribution
## Reviewing private pool repository contributions


<b>Starting</b>: There is a pending contribution to the private pool
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<b>Starting</b>: There is a pending contribution to the private pool
**Starting**: There is a pending contribution to the private pool.


<b>Workflow</b>:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<b>Workflow</b>:
**Workflow**:

* The reviewer goes through the pending contribution
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The reviewer goes through the pending contribution
* 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The reviewer checks the questions' relevance, format, metadata, whether they are different from the existing questions, while following the Reviewing guidelines
* The reviewer checks the questions' relevance, format, metadata, whether they are different from the existing questions, while following these guidelines.

* If needed, the reviewer gives feedback and requests changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* If needed, the reviewer gives feedback and requests changes
* If needed, the reviewer gives feedback and requests changes.


<b>Result</b>:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<b>Result</b>:
**Result**:

* The contribution is accepted and integrated in the private pool repo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The contribution is accepted and integrated in the private pool repo
* The contribution is accepted and integrated in the private pool repository.

* The contribution needs updates according to the feedback
* The contribution is rejected, for one of these reasons:
* The question is irrelevant, incorrect or unfixable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The question is irrelevant, incorrect or unfixable
* The question is irrelevant, incorrect or unfixable.

* The question already exists in the public pool repo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The question already exists in the public pool repo
* The question already exists in the public pool repository.

* The question already exists in the private pool repo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The question already exists in the private pool repo
* The question already exists in the private pool repository.