diff --git a/docs/img/reviews/Screenshot 2019-10-17 at 01.59.32.png b/docs/img/reviews/Screenshot 2019-10-17 at 01.59.32.png new file mode 100644 index 000000000..a806b9610 Binary files /dev/null and b/docs/img/reviews/Screenshot 2019-10-17 at 01.59.32.png differ diff --git a/docs/img/reviews/Screenshot 2019-10-17 at 02.03.11.png b/docs/img/reviews/Screenshot 2019-10-17 at 02.03.11.png new file mode 100644 index 000000000..afcf3fe48 Binary files /dev/null and b/docs/img/reviews/Screenshot 2019-10-17 at 02.03.11.png differ diff --git a/docs/img/reviews/Screenshot 2019-10-17 at 02.05.46.png b/docs/img/reviews/Screenshot 2019-10-17 at 02.05.46.png new file mode 100644 index 000000000..582be5c8f Binary files /dev/null and b/docs/img/reviews/Screenshot 2019-10-17 at 02.05.46.png differ diff --git a/docs/img/reviews/Screenshot 2019-10-17 at 02.20.18.png b/docs/img/reviews/Screenshot 2019-10-17 at 02.20.18.png new file mode 100644 index 000000000..17b7788dd Binary files /dev/null and b/docs/img/reviews/Screenshot 2019-10-17 at 02.20.18.png differ diff --git a/docs/img/reviews/Screenshot 2019-10-17 at 02.22.30.png b/docs/img/reviews/Screenshot 2019-10-17 at 02.22.30.png new file mode 100644 index 000000000..8e9a04494 Binary files /dev/null and b/docs/img/reviews/Screenshot 2019-10-17 at 02.22.30.png differ diff --git a/docs/img/reviews/Screenshot 2019-10-17 at 02.24.04.png b/docs/img/reviews/Screenshot 2019-10-17 at 02.24.04.png new file mode 100644 index 000000000..9dea5bf78 Binary files /dev/null and b/docs/img/reviews/Screenshot 2019-10-17 at 02.24.04.png differ diff --git a/docs/img/reviews/Screenshot 2019-10-17 at 02.38.37.png b/docs/img/reviews/Screenshot 2019-10-17 at 02.38.37.png new file mode 100644 index 000000000..d5db13fb8 Binary files /dev/null and b/docs/img/reviews/Screenshot 2019-10-17 at 02.38.37.png differ diff --git a/docs/reviews.md b/docs/reviews.md new file mode 100644 index 000000000..e18dd12e3 --- /dev/null +++ b/docs/reviews.md @@ -0,0 +1,48 @@ +# Reviews + +## Context + +Only bonus exercises can be reviewed, which are the last items of a quest. +Bonus exercises are available in quests 02 / 03 / 04 / 05 /07 / 08 / 09. +Screenshot 2019-10-17 at 02.38.37 + +Making a review involves 2 students who are gonna review each other's exercise. +Each user has to : + +- check the code of the other one on Github +- bet if it's gonna fail or succeed in the Review interface +- run his own exercise in the Review interface to give a result to compare with the bet, and state if it was right or wrong + +## Usage + +To submit an exercise to review and be reviewed, go to the `Review panel` on the right of the quest interface and click on the button to submit it : + +Screenshot 2019-10-17 at 01.59.32 + +Then, when a match with another student who also wants to review is found, you'll be notified : + +Screenshot 2019-10-17 at 02.03.11 + +Once you and the other student have confirmed the match, you can go and check the code of the other student on his repository in the component `Your review` : + +Screenshot 2019-10-17 at 02.05.46 + +When you've checked his code, those 4 steps will have to be completed to achieve the review : + +- You have to bet if the exercise of the other student will fail or succeed after running the tester +- The other student has to do the same with your exercise and make his own bet, that you can see on the component `Review of your exercise` + Screenshot 2019-10-17 at 02.20.18 + +- Once the other student's bet is set, the tester button unblocks and you have to run it on your exercise to output the result determining if your exercise has failed or succeeded ; this result is compared to the other student's bet to determine if it was wrong or right +- The other student also has to run the tester on his exercise to determine his result and so if your bet was wrong or right + Screenshot 2019-10-17 at 02.22.30 + +In fact, a bet is succeeded if it's equal as the tester output : +Screenshot 2019-10-17 at 02.24.04 + +You can have those 4 cases : + +- You bet that the exercise will **fail**, the tester output states that the exercise has **failed** -> the bet is **succeeded** +- You bet that the exercise will **succeed**, the tester output states that the exercise has **succeeded** -> the bet is **succeeded** +- You bet that the exercise will **fail**, the tester output states that the exercise has **succeeded** -> the bet is **failed** +- You bet that the exercise will **succeed**, the tester output states that the exercise has **failed** -> the bet is **failed**