Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2020 - E2086. Let course staff as well as students do reviews

2020-10-27T23:44:30Z

Twang33: /* Perform review */

== Project Index ==
* Deployment Link:

* Github Repository:
https://github.com/MayoNaizz/expertiza
* Github Pull Request:

* Video Link:

== Project Background ==

* Expertiza Project - E2086 : Let course staff as well as students do reviews

=== Why This Project ===

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development. By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

=== Primary Goal of this Project===

This project aims to allow instructors to submit reviews of student work, using the same review form that students use to do reviews

=== Files Involved ===

list_submissions.html.erb

_calibration_report.html.erb

response.html.erb

=== Project Team Member===

* Chenwei Zhou (czhou6)
* Tianrui Wang (twang33)
* Zhuolin Li(zli82)
* Hao Zhang (hzhang62)

== Project Design Philosophy ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Third, we plan to enable the instructor/TA to do review instead of assign grade in the review round. After the review Round, the review review session will be closed and replaced with assigning grade interface</li>
</ol>

== Design Flowchart ==
*When creating the assignment, the instructor should get a checkbox option asking whether allow the instructor to review all submissions as shown below.
[[File:E2086 flowchart1.png]]

*Ideal Process of this function
[[File:E2086 flowchart2.png]]

== Issue ==
=== Plan of Work ===
*In the assignment page of the Expertiza, If an instructor or a TA is a participant in an assignment, then the instructor should be able to review any team that has submitted the assignment.
*In order to see who is participating in the assignment, click on the “Add participants” icon (the one with the + sign and a picture of a person). That will bring up a list of participants and allow you to add more participants.
*Make the instructor and/or TAs participants, and then they should be allowed to do reviews.
[[File:E2086 assignment.png|900px]]

*Then, to perform reviews, the instructor/TA would click on the clipboard-like “View submissions” icon, as shown below.
[[File:E2086 view submission.png|900px]]

*A list of submissions would be pulled up:
[[File:E2086 submission.png|900px]]
*If the last due date for the assignment has not passed, then the “Assign grade” link should be changed to “Perform review”, and when clicked on, it should pull up a review page for the team, showing their submitted work at the top, as a review page normally does.
* We will add the review link in <code>views/assignments/list_submissions.html.erb</code> and once instructor/TA click that link. Controller <code> response </code> will be called. If the due day of the review round pass, this link will be replaced by the grade link. This link will also be added in <code>views/assignments/list_submissions.html.erb </code>

*Also, it would be more clear if we could mark the instructor's review with something special on the reviews page, as shown below.
*We will add an icon in <code>views/grades/view_team.html.erb</code> and <code>app/views/response/view.html.erb</code> if these review is made by instructor or TA.
[[File:E2086 review.png|700px]]

== Test Plan ==
The basic idea of this project is to change the 'Assign Grade' link to 'Perform review' if the deadline of a assignment has not passed. Thus, to test the functionality of this part, we plan to test it at the frontend

=== Configuration ===
<ol>

<li> Click 'Manage' -> 'Assignments' to go to assignment page.</li>
<li> Add a new assignment for a course that the current account has registered. Make sure the due date of the assignment is after the the time to perform the review as an instructor.</li>
<li> Click 'Add participants' icon in the new created assignment row, and 'Copy participants from course' to add all students registered to this course. Then add the current instructor account to this assignment through 'Enter a user login:' input space.</li>
<li> Impersonate as one of the students to simulate the submission of work.</li>
</ol>

=== Perform review ===
<ol>
<li> Click 'Manage' -> 'Assignments' to go to assignment page as instructor.</li>
<li> Click 'View submission' icon in the new created assignment row. Now the 'Perform review' link show be under participants name if the due date has not passed.</li>
<li> Click one of the 'Perform review' link to do the review for a certain submission by using the same templet of student peer review.</li>
<li> Impersonate the student that was previously reviewed by instructor. Check score for the assignment, and the review from the instructor should be recognizable from other student reviews.</li>
</ol>

== Refactor & Code Modification ==

== Running Tests ==
<pre>
rspec
</pre>

== Rspec Test Cases ==

== Reference & Links ==
=== Previous Implementation ===
This project was done by Team E1985 on Fall 2019 with the following work:

Expertiza wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1985._Let_course_staff_and_students_do_reviews

Github Pull Request: https://github.com/expertiza/expertiza/pull/1631

Github repository: https://github.com/Matrawick/expertiza

Youtube screencast: https://youtu.be/kLfZ22vlu30

=== Comments From Mentor ===
* Code for testing whether a reviewer is a staff member is put into an unrelated class (same method already exists elsewhere in system).

* There is a long code clone because the process of creating a mapping and a review is not quite the same as when the reviewer is a non-instructor; a lot of checks needed in that case are not needed here. But the current code should have been refactored to put the common code into another method.

* One test has been removed because it broke the build, & was evid. unrelated to their functionality.

* The commit was too messy; if this had been merged, it would have required refactoring.

for more information about this project, please visit [https://docs.google.com/document/d/1qphGGe8imRNufw2EhTZRqgs-I6XiQX74_I3UiwpPs5M/edit# Project Lists]

CSC/ECE 517 Fall 2020 - E2086. Let course staff as well as students do reviews

2020-10-27T23:44:19Z

Twang33: /* Configuration */

== Project Index ==
* Deployment Link:

* Github Repository:
https://github.com/MayoNaizz/expertiza
* Github Pull Request:

* Video Link:

== Project Background ==

* Expertiza Project - E2086 : Let course staff as well as students do reviews

=== Why This Project ===

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development. By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

=== Primary Goal of this Project===

This project aims to allow instructors to submit reviews of student work, using the same review form that students use to do reviews

=== Files Involved ===

list_submissions.html.erb

_calibration_report.html.erb

response.html.erb

=== Project Team Member===

* Chenwei Zhou (czhou6)
* Tianrui Wang (twang33)
* Zhuolin Li(zli82)
* Hao Zhang (hzhang62)

== Project Design Philosophy ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Third, we plan to enable the instructor/TA to do review instead of assign grade in the review round. After the review Round, the review review session will be closed and replaced with assigning grade interface</li>
</ol>

== Design Flowchart ==
*When creating the assignment, the instructor should get a checkbox option asking whether allow the instructor to review all submissions as shown below.
[[File:E2086 flowchart1.png]]

*Ideal Process of this function
[[File:E2086 flowchart2.png]]

== Issue ==
=== Plan of Work ===
*In the assignment page of the Expertiza, If an instructor or a TA is a participant in an assignment, then the instructor should be able to review any team that has submitted the assignment.
*In order to see who is participating in the assignment, click on the “Add participants” icon (the one with the + sign and a picture of a person). That will bring up a list of participants and allow you to add more participants.
*Make the instructor and/or TAs participants, and then they should be allowed to do reviews.
[[File:E2086 assignment.png|900px]]

*Then, to perform reviews, the instructor/TA would click on the clipboard-like “View submissions” icon, as shown below.
[[File:E2086 view submission.png|900px]]

*A list of submissions would be pulled up:
[[File:E2086 submission.png|900px]]
*If the last due date for the assignment has not passed, then the “Assign grade” link should be changed to “Perform review”, and when clicked on, it should pull up a review page for the team, showing their submitted work at the top, as a review page normally does.
* We will add the review link in <code>views/assignments/list_submissions.html.erb</code> and once instructor/TA click that link. Controller <code> response </code> will be called. If the due day of the review round pass, this link will be replaced by the grade link. This link will also be added in <code>views/assignments/list_submissions.html.erb </code>

*Also, it would be more clear if we could mark the instructor's review with something special on the reviews page, as shown below.
*We will add an icon in <code>views/grades/view_team.html.erb</code> and <code>app/views/response/view.html.erb</code> if these review is made by instructor or TA.
[[File:E2086 review.png|700px]]

== Test Plan ==
The basic idea of this project is to change the 'Assign Grade' link to 'Perform review' if the deadline of a assignment has not passed. Thus, to test the functionality of this part, we plan to test it at the frontend

=== Configuration ===
<ol>

<li> Click 'Manage' -> 'Assignments' to go to assignment page.</li>
<li> Add a new assignment for a course that the current account has registered. Make sure the due date of the assignment is after the the time to perform the review as an instructor.</li>
<li> Click 'Add participants' icon in the new created assignment row, and 'Copy participants from course' to add all students registered to this course. Then add the current instructor account to this assignment through 'Enter a user login:' input space.</li>
<li> Impersonate as one of the students to simulate the submission of work.</li>
</ol>

=== Perform review ===

<li> Click 'Manage' -> 'Assignments' to go to assignment page as instructor.</li>
<li> Click 'View submission' icon in the new created assignment row. Now the 'Perform review' link show be under participants name if the due date has not passed.</li>
<li> Click one of the 'Perform review' link to do the review for a certain submission by using the same templet of student peer review.</li>
<li> Impersonate the student that was previously reviewed by instructor. Check score for the assignment, and the review from the instructor should be recognizable from other student reviews.</li>

== Refactor & Code Modification ==

== Running Tests ==
<pre>
rspec
</pre>

== Rspec Test Cases ==

== Reference & Links ==
=== Previous Implementation ===
This project was done by Team E1985 on Fall 2019 with the following work:

Expertiza wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1985._Let_course_staff_and_students_do_reviews

Github Pull Request: https://github.com/expertiza/expertiza/pull/1631

Github repository: https://github.com/Matrawick/expertiza

Youtube screencast: https://youtu.be/kLfZ22vlu30

=== Comments From Mentor ===
* Code for testing whether a reviewer is a staff member is put into an unrelated class (same method already exists elsewhere in system).

* There is a long code clone because the process of creating a mapping and a review is not quite the same as when the reviewer is a non-instructor; a lot of checks needed in that case are not needed here. But the current code should have been refactored to put the common code into another method.

* One test has been removed because it broke the build, & was evid. unrelated to their functionality.

* The commit was too messy; if this had been merged, it would have required refactoring.

for more information about this project, please visit [https://docs.google.com/document/d/1qphGGe8imRNufw2EhTZRqgs-I6XiQX74_I3UiwpPs5M/edit# Project Lists]

CSC/ECE 517 Fall 2020 - E2086. Let course staff as well as students do reviews

2020-10-27T23:43:57Z

Twang33: /* Perform review */

== Project Index ==
* Deployment Link:

* Github Repository:
https://github.com/MayoNaizz/expertiza
* Github Pull Request:

* Video Link:

== Project Background ==

* Expertiza Project - E2086 : Let course staff as well as students do reviews

=== Why This Project ===

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development. By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

=== Primary Goal of this Project===

This project aims to allow instructors to submit reviews of student work, using the same review form that students use to do reviews

=== Files Involved ===

list_submissions.html.erb

_calibration_report.html.erb

response.html.erb

=== Project Team Member===

* Chenwei Zhou (czhou6)
* Tianrui Wang (twang33)
* Zhuolin Li(zli82)
* Hao Zhang (hzhang62)

== Project Design Philosophy ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Third, we plan to enable the instructor/TA to do review instead of assign grade in the review round. After the review Round, the review review session will be closed and replaced with assigning grade interface</li>
</ol>

== Design Flowchart ==
*When creating the assignment, the instructor should get a checkbox option asking whether allow the instructor to review all submissions as shown below.
[[File:E2086 flowchart1.png]]

*Ideal Process of this function
[[File:E2086 flowchart2.png]]

== Issue ==
=== Plan of Work ===
*In the assignment page of the Expertiza, If an instructor or a TA is a participant in an assignment, then the instructor should be able to review any team that has submitted the assignment.
*In order to see who is participating in the assignment, click on the “Add participants” icon (the one with the + sign and a picture of a person). That will bring up a list of participants and allow you to add more participants.
*Make the instructor and/or TAs participants, and then they should be allowed to do reviews.
[[File:E2086 assignment.png|900px]]

*Then, to perform reviews, the instructor/TA would click on the clipboard-like “View submissions” icon, as shown below.
[[File:E2086 view submission.png|900px]]

*A list of submissions would be pulled up:
[[File:E2086 submission.png|900px]]
*If the last due date for the assignment has not passed, then the “Assign grade” link should be changed to “Perform review”, and when clicked on, it should pull up a review page for the team, showing their submitted work at the top, as a review page normally does.
* We will add the review link in <code>views/assignments/list_submissions.html.erb</code> and once instructor/TA click that link. Controller <code> response </code> will be called. If the due day of the review round pass, this link will be replaced by the grade link. This link will also be added in <code>views/assignments/list_submissions.html.erb </code>

*Also, it would be more clear if we could mark the instructor's review with something special on the reviews page, as shown below.
*We will add an icon in <code>views/grades/view_team.html.erb</code> and <code>app/views/response/view.html.erb</code> if these review is made by instructor or TA.
[[File:E2086 review.png|700px]]

== Test Plan ==
The basic idea of this project is to change the 'Assign Grade' link to 'Perform review' if the deadline of a assignment has not passed. Thus, to test the functionality of this part, we plan to test it at the frontend

=== Configuration ===
<ol>

<li> Click 'Manage' -> 'Assignments' to go to assignment page.</li>
<li> Add a new assignment for a course that the current account has registered. Make sure the due date of the assignment is after the the time to perform the review as an instructor.</li>
<li> Click 'Add participants' icon in the new created assignment row, and 'Copy participants from course' to add all students registered to this course. Then add the current instructor account to this assignment through 'Enter a user login:' input space.</li>
<li> Impersonate as one of the students to simulate the submission of work.</li>

=== Perform review ===

<li> Click 'Manage' -> 'Assignments' to go to assignment page as instructor.</li>
<li> Click 'View submission' icon in the new created assignment row. Now the 'Perform review' link show be under participants name if the due date has not passed.</li>
<li> Click one of the 'Perform review' link to do the review for a certain submission by using the same templet of student peer review.</li>
<li> Impersonate the student that was previously reviewed by instructor. Check score for the assignment, and the review from the instructor should be recognizable from other student reviews.</li>

== Refactor & Code Modification ==

== Running Tests ==
<pre>
rspec
</pre>

== Rspec Test Cases ==

== Reference & Links ==
=== Previous Implementation ===
This project was done by Team E1985 on Fall 2019 with the following work:

Expertiza wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1985._Let_course_staff_and_students_do_reviews

Github Pull Request: https://github.com/expertiza/expertiza/pull/1631

Github repository: https://github.com/Matrawick/expertiza

Youtube screencast: https://youtu.be/kLfZ22vlu30

=== Comments From Mentor ===
* Code for testing whether a reviewer is a staff member is put into an unrelated class (same method already exists elsewhere in system).

* There is a long code clone because the process of creating a mapping and a review is not quite the same as when the reviewer is a non-instructor; a lot of checks needed in that case are not needed here. But the current code should have been refactored to put the common code into another method.

* One test has been removed because it broke the build, & was evid. unrelated to their functionality.

* The commit was too messy; if this had been merged, it would have required refactoring.

for more information about this project, please visit [https://docs.google.com/document/d/1qphGGe8imRNufw2EhTZRqgs-I6XiQX74_I3UiwpPs5M/edit# Project Lists]

CSC/ECE 517 Fall 2020 - E2086. Let course staff as well as students do reviews

2020-10-27T23:43:27Z

Twang33: /* Configuration */

== Project Index ==
* Deployment Link:

* Github Repository:
https://github.com/MayoNaizz/expertiza
* Github Pull Request:

* Video Link:

== Project Background ==

* Expertiza Project - E2086 : Let course staff as well as students do reviews

=== Why This Project ===

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development. By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

=== Primary Goal of this Project===

This project aims to allow instructors to submit reviews of student work, using the same review form that students use to do reviews

=== Files Involved ===

list_submissions.html.erb

_calibration_report.html.erb

response.html.erb

=== Project Team Member===

* Chenwei Zhou (czhou6)
* Tianrui Wang (twang33)
* Zhuolin Li(zli82)
* Hao Zhang (hzhang62)

== Project Design Philosophy ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Third, we plan to enable the instructor/TA to do review instead of assign grade in the review round. After the review Round, the review review session will be closed and replaced with assigning grade interface</li>
</ol>

== Design Flowchart ==
*When creating the assignment, the instructor should get a checkbox option asking whether allow the instructor to review all submissions as shown below.
[[File:E2086 flowchart1.png]]

*Ideal Process of this function
[[File:E2086 flowchart2.png]]

== Issue ==
=== Plan of Work ===
*In the assignment page of the Expertiza, If an instructor or a TA is a participant in an assignment, then the instructor should be able to review any team that has submitted the assignment.
*In order to see who is participating in the assignment, click on the “Add participants” icon (the one with the + sign and a picture of a person). That will bring up a list of participants and allow you to add more participants.
*Make the instructor and/or TAs participants, and then they should be allowed to do reviews.
[[File:E2086 assignment.png|900px]]

*Then, to perform reviews, the instructor/TA would click on the clipboard-like “View submissions” icon, as shown below.
[[File:E2086 view submission.png|900px]]

*A list of submissions would be pulled up:
[[File:E2086 submission.png|900px]]
*If the last due date for the assignment has not passed, then the “Assign grade” link should be changed to “Perform review”, and when clicked on, it should pull up a review page for the team, showing their submitted work at the top, as a review page normally does.
* We will add the review link in <code>views/assignments/list_submissions.html.erb</code> and once instructor/TA click that link. Controller <code> response </code> will be called. If the due day of the review round pass, this link will be replaced by the grade link. This link will also be added in <code>views/assignments/list_submissions.html.erb </code>

*Also, it would be more clear if we could mark the instructor's review with something special on the reviews page, as shown below.
*We will add an icon in <code>views/grades/view_team.html.erb</code> and <code>app/views/response/view.html.erb</code> if these review is made by instructor or TA.
[[File:E2086 review.png|700px]]

== Test Plan ==
The basic idea of this project is to change the 'Assign Grade' link to 'Perform review' if the deadline of a assignment has not passed. Thus, to test the functionality of this part, we plan to test it at the frontend

=== Configuration ===
<ol>

<li> Click 'Manage' -> 'Assignments' to go to assignment page.</li>
<li> Add a new assignment for a course that the current account has registered. Make sure the due date of the assignment is after the the time to perform the review as an instructor.</li>
<li> Click 'Add participants' icon in the new created assignment row, and 'Copy participants from course' to add all students registered to this course. Then add the current instructor account to this assignment through 'Enter a user login:' input space.</li>
<li> Impersonate as one of the students to simulate the submission of work.</li>

=== Perform review ===

1. Click 'Manage' -> 'Assignments' to go to assignment page as instructor.
2. Click 'View submission' icon in the new created assignment row. Now the 'Perform review' link show be under participants name if the due date has not passed.
3. Click one of the 'Perform review' link to do the review for a certain submission by using the same templet of student peer review.
4. Impersonate the student that was previously reviewed by instructor. Check score for the assignment, and the review from the instructor should be recognizable from other student reviews.

== Refactor & Code Modification ==

== Running Tests ==
<pre>
rspec
</pre>

== Rspec Test Cases ==

== Reference & Links ==
=== Previous Implementation ===
This project was done by Team E1985 on Fall 2019 with the following work:

Expertiza wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1985._Let_course_staff_and_students_do_reviews

Github Pull Request: https://github.com/expertiza/expertiza/pull/1631

Github repository: https://github.com/Matrawick/expertiza

Youtube screencast: https://youtu.be/kLfZ22vlu30

=== Comments From Mentor ===
* Code for testing whether a reviewer is a staff member is put into an unrelated class (same method already exists elsewhere in system).

* There is a long code clone because the process of creating a mapping and a review is not quite the same as when the reviewer is a non-instructor; a lot of checks needed in that case are not needed here. But the current code should have been refactored to put the common code into another method.

* One test has been removed because it broke the build, & was evid. unrelated to their functionality.

* The commit was too messy; if this had been merged, it would have required refactoring.

for more information about this project, please visit [https://docs.google.com/document/d/1qphGGe8imRNufw2EhTZRqgs-I6XiQX74_I3UiwpPs5M/edit# Project Lists]

CSC/ECE 517 Fall 2020 - E2086. Let course staff as well as students do reviews

2020-10-27T23:42:59Z

Twang33: /* Configuration */

== Project Index ==
* Deployment Link:

* Github Repository:
https://github.com/MayoNaizz/expertiza
* Github Pull Request:

* Video Link:

== Project Background ==

* Expertiza Project - E2086 : Let course staff as well as students do reviews

=== Why This Project ===

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development. By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

=== Primary Goal of this Project===

This project aims to allow instructors to submit reviews of student work, using the same review form that students use to do reviews

=== Files Involved ===

list_submissions.html.erb

_calibration_report.html.erb

response.html.erb

=== Project Team Member===

* Chenwei Zhou (czhou6)
* Tianrui Wang (twang33)
* Zhuolin Li(zli82)
* Hao Zhang (hzhang62)

== Project Design Philosophy ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Third, we plan to enable the instructor/TA to do review instead of assign grade in the review round. After the review Round, the review review session will be closed and replaced with assigning grade interface</li>
</ol>

== Design Flowchart ==
*When creating the assignment, the instructor should get a checkbox option asking whether allow the instructor to review all submissions as shown below.
[[File:E2086 flowchart1.png]]

*Ideal Process of this function
[[File:E2086 flowchart2.png]]

== Issue ==
=== Plan of Work ===
*In the assignment page of the Expertiza, If an instructor or a TA is a participant in an assignment, then the instructor should be able to review any team that has submitted the assignment.
*In order to see who is participating in the assignment, click on the “Add participants” icon (the one with the + sign and a picture of a person). That will bring up a list of participants and allow you to add more participants.
*Make the instructor and/or TAs participants, and then they should be allowed to do reviews.
[[File:E2086 assignment.png|900px]]

*Then, to perform reviews, the instructor/TA would click on the clipboard-like “View submissions” icon, as shown below.
[[File:E2086 view submission.png|900px]]

*A list of submissions would be pulled up:
[[File:E2086 submission.png|900px]]
*If the last due date for the assignment has not passed, then the “Assign grade” link should be changed to “Perform review”, and when clicked on, it should pull up a review page for the team, showing their submitted work at the top, as a review page normally does.
* We will add the review link in <code>views/assignments/list_submissions.html.erb</code> and once instructor/TA click that link. Controller <code> response </code> will be called. If the due day of the review round pass, this link will be replaced by the grade link. This link will also be added in <code>views/assignments/list_submissions.html.erb </code>

*Also, it would be more clear if we could mark the instructor's review with something special on the reviews page, as shown below.
*We will add an icon in <code>views/grades/view_team.html.erb</code> and <code>app/views/response/view.html.erb</code> if these review is made by instructor or TA.
[[File:E2086 review.png|700px]]

== Test Plan ==
The basic idea of this project is to change the 'Assign Grade' link to 'Perform review' if the deadline of a assignment has not passed. Thus, to test the functionality of this part, we plan to test it at the frontend

=== Configuration ===
<ol>

<li>1. Click 'Manage' -> 'Assignments' to go to assignment page.</li>
2. Add a new assignment for a course that the current account has registered. Make sure the due date of the assignment is after the the time to perform the review as an instructor.
3. Click 'Add participants' icon in the new created assignment row, and 'Copy participants from course' to add all students registered to this course. Then add the current instructor account to this assignment through 'Enter a user login:' input space.
4. Impersonate as one of the students to simulate the submission of work.

=== Perform review ===

1. Click 'Manage' -> 'Assignments' to go to assignment page as instructor.
2. Click 'View submission' icon in the new created assignment row. Now the 'Perform review' link show be under participants name if the due date has not passed.
3. Click one of the 'Perform review' link to do the review for a certain submission by using the same templet of student peer review.
4. Impersonate the student that was previously reviewed by instructor. Check score for the assignment, and the review from the instructor should be recognizable from other student reviews.

== Refactor & Code Modification ==

== Running Tests ==
<pre>
rspec
</pre>

== Rspec Test Cases ==

== Reference & Links ==
=== Previous Implementation ===
This project was done by Team E1985 on Fall 2019 with the following work:

Expertiza wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1985._Let_course_staff_and_students_do_reviews

Github Pull Request: https://github.com/expertiza/expertiza/pull/1631

Github repository: https://github.com/Matrawick/expertiza

Youtube screencast: https://youtu.be/kLfZ22vlu30

=== Comments From Mentor ===
* Code for testing whether a reviewer is a staff member is put into an unrelated class (same method already exists elsewhere in system).

* There is a long code clone because the process of creating a mapping and a review is not quite the same as when the reviewer is a non-instructor; a lot of checks needed in that case are not needed here. But the current code should have been refactored to put the common code into another method.

* One test has been removed because it broke the build, & was evid. unrelated to their functionality.

* The commit was too messy; if this had been merged, it would have required refactoring.

for more information about this project, please visit [https://docs.google.com/document/d/1qphGGe8imRNufw2EhTZRqgs-I6XiQX74_I3UiwpPs5M/edit# Project Lists]

CSC/ECE 517 Fall 2020 - E2086. Let course staff as well as students do reviews

2020-10-27T23:12:42Z

Twang33: /* Test Plan */

== Project Index ==
* Deployment Link:

* Github Repository:
https://github.com/MayoNaizz/expertiza
* Github Pull Request:

* Video Link:

== Project Background ==

* Expertiza Project - E2086 : Let course staff as well as students do reviews

=== Why This Project ===

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development. By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

=== Primary Goal of this Project===

This project aims to allow instructors to submit reviews of student work, using the same review form that students use to do reviews

=== Files Involved ===

list_submissions.html.erb

_calibration_report.html.erb

response.html.erb

=== Project Team Member===

* Chenwei Zhou (czhou6)
* Tianrui Wang (twang33)
* Zhuolin Li(zli82)
* Hao Zhang (hzhang62)

== Project Design Philosophy ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Third, we plan to enable the instructor/TA to do review instead of assign grade in the review round. After the review Round, the review review session will be closed and replaced with assigning grade interface</li>
</ol>

== Design Flowchart ==
*When creating the assignment, the instructor should get a checkbox option asking whether allow the instructor to review all submissions as shown below.
[[File:E2086 flowchart1.png]]

*Ideal Process of this function
[[File:E2086 flowchart2.png]]

== Issue ==
=== Plan of Work ===
*In the assignment page of the Expertiza, If an instructor or a TA is a participant in an assignment, then the instructor should be able to review any team that has submitted the assignment.
*In order to see who is participating in the assignment, click on the “Add participants” icon (the one with the + sign and a picture of a person). That will bring up a list of participants and allow you to add more participants.
*Make the instructor and/or TAs participants, and then they should be allowed to do reviews.
[[File:E2086 assignment.png|900px]]

*Then, to perform reviews, the instructor/TA would click on the clipboard-like “View submissions” icon, as shown below.
[[File:E2086 view submission.png|900px]]

*A list of submissions would be pulled up:
[[File:E2086 submission.png|900px]]
*If the last due date for the assignment has not passed, then the “Assign grade” link should be changed to “Perform review”, and when clicked on, it should pull up a review page for the team, showing their submitted work at the top, as a review page normally does.

*Also, it would be more clear if we could mark the instructor's review with something special on the reviews page, as shown below.
[[File:E2086 review.png|700px]]

== Test Plan ==
The basic idea of this project is to change the 'Assign Grade' link to 'Perform review' if the deadline of a assignment has not passed. Thus, to test the functionality of this part, we plan to test it at the frontend

=== Configuration ===
1. Click 'Manage' -> 'Assignments' to go to assignment page.
2. Add a new assignment for a course that the current account has registered. Make sure the due date of the assignment is after the the time to perform the review as an instructor.
3. Click 'Add participants' icon in the new created assignment row, and 'Copy participants from course' to add all students registered to this course. Then add the current instructor account to this assignment through 'Enter a user login:' input space.
4. Impersonate as one of the students to simulate the submission of work.

=== Perform review ===

1. Click 'Manage' -> 'Assignments' to go to assignment page as instructor.
2. Click 'View submission' icon in the new created assignment row. Now the 'Perform review' link show be under participants name if the due date has not passed.
3. Click one of the 'Perform review' link to do the review for a certain submission by using the same templet of student peer review.
4. Impersonate the student that was previously reviewed by instructor. Check score for the assignment, and the review from the instructor should be recognizable from other student reviews.

== Refactor & Code Modification ==

== Running Tests ==
<pre>
rspec
</pre>

== Rspec Test Cases ==

== Reference & Links ==
=== Previous Implementation ===
This project was done by Team E1985 on Fall 2019 with the following work:

Expertiza wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1985._Let_course_staff_and_students_do_reviews

Github Pull Request: https://github.com/expertiza/expertiza/pull/1631

Github repository: https://github.com/Matrawick/expertiza

Youtube screencast: https://youtu.be/kLfZ22vlu30

=== Comments From Mentor ===
* Code for testing whether a reviewer is a staff member is put into an unrelated class (same method already exists elsewhere in system).

* There is a long code clone because the process of creating a mapping and a review is not quite the same as when the reviewer is a non-instructor; a lot of checks needed in that case are not needed here. But the current code should have been refactored to put the common code into another method.

* One test has been removed because it broke the build, & was evid. unrelated to their functionality.

* The commit was too messy; if this had been merged, it would have required refactoring.

for more information about this project, please visit [https://docs.google.com/document/d/1qphGGe8imRNufw2EhTZRqgs-I6XiQX74_I3UiwpPs5M/edit# Project Lists]

CSC/ECE 517 Fall 2020 - E2086. Let course staff as well as students do reviews

2020-10-27T20:03:28Z

Twang33: /* Project Index */

== Project Index ==
* Deployment Link:

* Github Repository:
https://github.com/MayoNaizz/expertiza
* Github Pull Request:

* Video Link:

== Project Background ==

* Expertiza Project - E2086 : Let course staff as well as students do reviews

=== Why This Project ===

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development. By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

=== Primary Goal of this Project===

This project aims to allow instructors to submit reviews of student work, using the same review form that students use to do reviews

=== Files Involved ===

list_submissions.html.erb

_calibration_report.html.erb

response.html.erb

=== Project Team Member===

* Chenwei Zhou (czhou6)
* Tianrui Wang (twang33)
* Zhuolin Li(zli82)
* Hao Zhang (hzhang62)

== Project Design Philosophy ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Third, we plan to enable the instructor/TA to do review instead of assign grade in the review round. After the review Round, the review review session will be closed and replaced with assigning grade interface</li>
</ol>

== Design Flowchart ==
*When creating the assignment, the instructor should get a checkbox option asking whether allow the instructor to review all submissions as shown below.
[[File:E2086 flowchart1.png]]

*Ideal Process of this function
[[File:E2086 flowchart2.png]]

== Issue ==
=== Plan of Work ===
*In the assignment page of the Expertiza, If an instructor or a TA is a participant in an assignment, then the instructor should be able to review any team that has submitted the assignment.
*In order to see who is participating in the assignment, click on the “Add participants” icon (the one with the + sign and a picture of a person). That will bring up a list of participants and allow you to add more participants.
*Make the instructor and/or TAs participants, and then they should be allowed to do reviews.
[[File:E2086 assignment.png|900px]]

*Then, to perform reviews, the instructor/TA would click on the clipboard-like “View submissions” icon, as shown below.
[[File:E2086 view submission.png|900px]]

*A list of submissions would be pulled up:
[[File:E2086 submission.png|900px]]
*If the last due date for the assignment has not passed, then the “Assign grade” link should be changed to “Perform review”, and when clicked on, it should pull up a review page for the team, showing their submitted work at the top, as a review page normally does.

*Also, it would be more clear if we could mark the instructor's review with something special on the reviews page, as shown below.
[[File:E2086 review.png|700px]]

== Test Plan ==

== Refactor & Code Modification ==

== Running Tests ==
<pre>
rspec
</pre>

== Rspec Test Cases ==

== Reference & Links ==
=== Previous Implementation ===
This project was done by Team E1985 on Fall 2019 with the following work:

Expertiza wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1985._Let_course_staff_and_students_do_reviews

Github Pull Request: https://github.com/expertiza/expertiza/pull/1631

Github repository: https://github.com/Matrawick/expertiza

Youtube screencast: https://youtu.be/kLfZ22vlu30

=== Comments From Mentor ===
* Code for testing whether a reviewer is a staff member is put into an unrelated class (same method already exists elsewhere in system).

* There is a long code clone because the process of creating a mapping and a review is not quite the same as when the reviewer is a non-instructor; a lot of checks needed in that case are not needed here. But the current code should have been refactored to put the common code into another method.

* One test has been removed because it broke the build, & was evid. unrelated to their functionality.

* The commit was too messy; if this had been merged, it would have required refactoring.

for more information about this project, please visit [https://docs.google.com/document/d/1qphGGe8imRNufw2EhTZRqgs-I6XiQX74_I3UiwpPs5M/edit# Project Lists]

CSC/ECE 517 Fall 2020 - E2070. Refactor response controller.rb

2020-10-14T17:21:41Z

Twang33: /* METHOD: def show_calibration_results_for_student */

== Project Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Project Team Member===

* Chenwei Zhou (czhou6)
* Tianrui Wang (twang33)
* Xinran Li (xli56)

=== Goal of this Project===
This project tries to modify and refactor the response_controller.rb in a more clear way

=== Files Involved ===

response_controller.rb

response.rb

== Issue ==
=== Methods need to be fixed ===
* def assign_instance_vars
* def scores
* def new
* def set_questionnaire
* def set_questionnaire_for_new_response
* def show_calibration_results_for_students

=== Recommandation from mentor ===
[https://docs.google.com/document/d/1LCl_4jGFEQSz09c9TK1fVlVmOiGJ38OEVMxAsjAcEec/edit# Project Lists]
* def assign_instance_vars : This name could be more specific.
* def scores : This should be a model method (in response.rb)! It is all calculation.
* def new : This method contains a complicated condition that determines whether the submission has been updated since the last time it was reviewed. If it has not, then the reviewer can edit his/her previous review. If there has been an update, then the reviewer gets a new review form to “update” the review. It would make sense to have a model method that tests whether there has been a review since the last file or link was submitted. Then the code here would just call that function. It would be a lot clearer what the new method is doing. set_content(new_response = false) also plays a role in this calculation. Perhaps this method should also be included in the refactoring, for the sake of clarity of the resulting code.
* def set_questionnaire : Badly named; what kind of questionnaire and why? The name should be a lot clearer.
* def set_questionnaire_for_new_response : Badly named, no comments, not at all clear. The logic is not like set_questionnaire. Rename, refactor for clarity, and add comments as appropriate.
* def show_calibration_results_for_student : This method makes about five db accesses. Can it be broken into 2 methods, with the business logic moved to response.rb?

== Refactor & Code Modification ==
We did the following refactor to make this method more clear:

=== METHOD: def assign_instance_vars ===

*the instance variables are actually action handles to the views from controller including "new" and "edit", thus refactoring method name to assign_action_parameters would be better to understand what this method is trying to do.
*This method is a private helper method and is used in new and edit methods to set the action parameters for the new and edit actions

[[File:E2070 assign instance.png|1200px]]

*After renaming, the method became more clear of what it's doing

[[File:E2070 action parameters.png]]

=== METHOD: def scores ===

*This method was already defined in other classes and is useless in the current class, thus remove it would be a reasonable choice.

[[File:E2070 Scores.png|1200px]]

===METHOD: def set_questionnaire===

*In the method set_content in response_controller.rb, there is one line of code that "new_response ? set_questionnaire_for_new_response : set_questionnaire". Thus, we can tell the method set_qustionnaire will called when new_response is false, which means that the object was triggered by an existing response. In the method set_questionnaire, the line of code that “@questionnaire = @response.questionnaire_by_answer(answer)”, which is looking up the questionnaire answered by this existing response. Therefore, refactoring the method name to find_quesetionnaire would be better to understand.
[[File:E2070 set questionnaire.png|1200px]]

===METHOD: def set_questionnaire_for_new_response===

*In the method set_content in response_controller.rb, there is one line of code that "new_response ? set_questionnaire_for_new_response : set_questionnaire". Thus, we can tell the method set_qustionnaire will called when new_response is true, which means that the object was triggered by a new response. In the set_questionnaire_for_new_response method, the "cast" statement informs us that the new questionnaire are created based on the types or Reviewers, such as Review, Metareview, Teammate Review and so on. Therefore, refactoring the set_questionnaire_for_new_response method to create_new_questionnaire would be better to understand.
[[File:E2070 set questionnaire for new.png|1200px]]

===METHOD: def show_calibration_results_for_student ===
* This method shows the result of expert review for reviewer after teacher or TA submit the calibration by editing the assignment.
* The method makes about five database accesses and the code is quite messy and thus break it into 2 methods with the business logic moved to response.rb would be a good way to make the code in controller cleaner.

[[File:E2070 calibration controller.png|1200px]]

* The method get_questions_from_assignment is the part that's inside the model class and contains logic of mapping reviews with assignments in the questionnaire and return questions in the joined table
[[File:E2070 calibration model.png|1200px]]

====show_calibration page ====
[[File:E2070 calibration student view.png|900px]]

====Teacher's action to triggle this function ====
[[File:E2070 calibration edit assignment.png|900px]]

====After calibration function is activated====
[[File:E2070 expert review.png|900px]]

===METHOD: def new ===
*This method contains a complicated condition that determines whether the submission has been updated since the last time it was reviewed. If it has not, then the reviewer can edit his/her previous review. If there has been an update, then the reviewer gets a new review form to “update” the review.
*So we break the new method into two methods: new and get_most_recent_response and put the logic into the response controller class.
*The method get_most_recent_response in the model class tests whether there has been a review since the last file or link was submitted and in the controller this method was called to get the newest response.
[[File:E2070 new.png|1200px]]

* The new method after refactoring, now the code is quite clear and with only one appearance of variable "@response"
[[File:E2070 new method.png|1200px]]

====Create new response in the webpage====
[[File:E2070 request a new review.png|900px]]

====After NEW action====
[[File:E2070 new method called to generate new response.png|900px]]