Skip to content

Commit 93d13c5

Browse files
authored
Merge pull request #50 from Bobbins228/review-doc
Added review instructions to Contributing.md
2 parents 583bd0c + 0344348 commit 93d13c5

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,19 @@ This project uses ZenHub for tracking of issues and roadmap.
3030

3131
## Reporting an Issue
3232

33-
To report an issue, or to suggest an idea for a change, open an [issue](../../issues/new). It is best to check our existing [issues](../../issues) first to see if a similar one has already been opened and discussed.
33+
To report an issue, or to suggest an idea for a change, open an [issue](../../issues/new). It is best to check our existing [issues](../../issues) first to see if a similar one has already been opened and discussed.
34+
## Getting Feedback on Your Contribution
35+
36+
When creating a PR for one of our projects it is important to get your work reviewed by other members of the team. Below are some steps to getting your work reviewed. <br>
37+
* Assign a Reviewer from the list of reviewers on the project.
38+
* Change the status of the issue from `In Progress` to `Ready For Review` on the [Project Codeflare Sprint Board](https://github.com/orgs/project-codeflare/projects/8/views/3).
39+
* Once the PR is reviewed the reviewer may request changes to be made, or if they are happy with the PR they will apply an `lgtm` label.
40+
* You can now change the status of the issue to `In Review`.
41+
* When the `lgtm` label has been applied you can assign an Approver to your PR.
42+
* The approver may request more changes, or if they are happy with the PR they will apply the `approved` label. After this the PR will be merged.
43+
* You can now change the status of the issue to `Closed` if the status didn't change automatically after the merge.
44+
45+
### Reviewers and Approvers for each project
46+
* [MCAD](https://github.com/project-codeflare/multi-cluster-app-dispatcher/blob/main/OWNERS)
47+
* [InstaScale](https://github.com/project-codeflare/instascale/blob/main/OWNERS)
48+
* [Codeflare-SDK](https://github.com/project-codeflare/codeflare-sdk/blob/main/OWNERS)

0 commit comments

Comments
 (0)