Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T02:32:31Z

Hyu22: /* Changes in the User Interface (Todo) */

== Introduction ==
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1879) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

== Proposed solution ==
We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

== Implementation ==

=== Design Strategy ===

In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). So that we will add a new subclass of Questionnaire named SupplementaryReviewQuestionnaire to achieve our goal.

First, we want the professor to control if the students can create their own supplementary questions by using a checkbox to indicate. If the professor allow students to create their own questions, there will be a button in the students "Your work" page which can let the students jump to the same page that an instructor lands on when creating a new rubric. Then we will add the questionnaire id of this new SupplementaryReviewQuestionnaire to the Team table when students create their own questionnaire in order to show the corresponding supplementary questions to the reviewers. And when showing review questions to the reviewers we will look up the questionnaire id in Team table and modify the view to add the supplementary questions to review page. Finally, after the reviewers finish the review and submit their responds, we will change the view and let the team member can see the feedback of their supplementary questions.

=== Modifications in the User Interface (Todo) ===

1. Assignment Creation Page in Instructor's Account

We plan to implement a check box under the column of Rubrics in the assignment creation page indicating whether the instructor allows students to add specific questionnaires with respect to their projects.

2. Your Work Page in A Student's Account

We plan to implement a link or button on the Your Work page of an assignment of a student whose assignment is enabled to create supplementary review questionnaires by the instructor, in order to redirect to the Review Rubrics Creation page.

3. Review Rubrics Creation Page

In this page, students are able to create supplementary review questions regarding the specifics of their own assignments.

4. Review Page

In the Review Page of reviewers, the supplementary review questions created by the owner of the assignment will be shown to reviewers along with the standard review questions created by the instructor.

5. Review Results Page

The Review Results Page should display the results of standard questions created by the instructor as well as the results of supplementary review questions created by the instructor.

== Use Cases ==

1. Use case of creating a Supplementary Review Questionnaire

2. Use case of reviewing questions for reviewers.

3. Use case of reviewing responses of questions.

== Test Plan ==

Actually, we need to add tests for the following:

1. To check the link for "Supplementary Review Questionnaire" appears in the "Your Work" section of a student.

2. To check if the link for "Supplementary Review Questionnaire" redirects to page which allows to create questionnaire.

3. To check if the questionnaire ID is stored in the Team table.

4. To check if the reviewers can see the supplementary questions that were added by the team as part of the review questions.

5. To check if the responses of the Supplementary Review Questions have been added to the responses of the existing review questions.

== File which are added/modified ==

Note: Because the pull request contains some code irrelevant to this project which make it confusing, we post our code here for you to read clearly.

== Team members ==
Hua Cao

Heng Yu

Jianshu Zhang

Zirun Han

== Links ==
Expertiza on Github:https://github.com/zyczyh/expertiza

Pull Request:https://github.com/expertiza/expertiza/pull/1325

Expertiza YouTube channel:https://youtu.be/3PUNknSbU-k

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T02:31:37Z

Hyu22: /* Changes in the User Interface */

== Introduction ==
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1879) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

== Proposed solution ==
We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

== Implementation ==

=== Design Strategy ===

In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). So that we will add a new subclass of Questionnaire named SupplementaryReviewQuestionnaire to achieve our goal.

First, we want the professor to control if the students can create their own supplementary questions by using a checkbox to indicate. If the professor allow students to create their own questions, there will be a button in the students "Your work" page which can let the students jump to the same page that an instructor lands on when creating a new rubric. Then we will add the questionnaire id of this new SupplementaryReviewQuestionnaire to the Team table when students create their own questionnaire in order to show the corresponding supplementary questions to the reviewers. And when showing review questions to the reviewers we will look up the questionnaire id in Team table and modify the view to add the supplementary questions to review page. Finally, after the reviewers finish the review and submit their responds, we will change the view and let the team member can see the feedback of their supplementary questions.

=== Changes in the User Interface (Todo) ===

1. Assignment Creation Page in Instructor's Account

We plan to implement a check box under the column of Rubrics in the assignment creation page indicating whether the instructor allows students to add specific questionnaires with respect to their projects.

2. Your Work Page in A Student's Account

We plan to implement a link or button on the Your Work page of an assignment of a student whose assignment is enabled to create supplementary review questionnaires by the instructor, in order to redirect to the Review Rubrics Creation page.

3. Review Rubrics Creation Page

In this page, students are able to create supplementary review questions regarding the specifics of their own assignments.

4. Review Page

In the Review Page of reviewers, the supplementary review questions created by the owner of the assignment will be shown to reviewers along with the standard review questions created by the instructor.

5. Review Results Page

The Review Results Page should display the results of standard questions created by the instructor as well as the results of supplementary review questions created by the instructor.

== Use Cases ==

1. Use case of creating a Supplementary Review Questionnaire

2. Use case of reviewing questions for reviewers.

3. Use case of reviewing responses of questions.

== Test Plan ==

Actually, we need to add tests for the following:

1. To check the link for "Supplementary Review Questionnaire" appears in the "Your Work" section of a student.

2. To check if the link for "Supplementary Review Questionnaire" redirects to page which allows to create questionnaire.

3. To check if the questionnaire ID is stored in the Team table.

4. To check if the reviewers can see the supplementary questions that were added by the team as part of the review questions.

5. To check if the responses of the Supplementary Review Questions have been added to the responses of the existing review questions.

== File which are added/modified ==

Note: Because the pull request contains some code irrelevant to this project which make it confusing, we post our code here for you to read clearly.

== Team members ==
Hua Cao

Heng Yu

Jianshu Zhang

Zirun Han

== Links ==
Expertiza on Github:https://github.com/zyczyh/expertiza

Pull Request:https://github.com/expertiza/expertiza/pull/1325

Expertiza YouTube channel:https://youtu.be/3PUNknSbU-k

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T02:02:06Z

Hyu22: /* Team members */

== Introduction ==
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1879) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

== Proposed solution ==
We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

== Implementation ==

=== Design Strategy ===

In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). So that we will add a new subclass of Questionnaire named SupplementaryReviewQuestionnaire to achieve our goal.

First, we want the professor to control if the students can create their own supplementary questions by using a checkbox to indicate. If the professor allow students to create their own questions, there will be a button in the students "Your work" page which can let the students jump to the same page that an instructor lands on when creating a new rubric. Then we will add the questionnaire id of this new SupplementaryReviewQuestionnaire to the Team table when students create their own questionnaire in order to show the corresponding supplementary questions to the reviewers. And when showing review questions to the reviewers we will look up the questionnaire id in Team table and modify the view to add the supplementary questions to review page. Finally, after the reviewers finish the review and submit their responds, we will change the view and let the team member can see the feedback of their supplementary questions.

=== Changes in the User Interface ===

1. Assignment Page

We add a checkbox for the professor to indicate if student can add their own questions.

2. A button called "Create Supplementary Rubric" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the button he/she can add the desired questions.

3. The page where student will be directed to when he/she clicks the Create Supplementary Rubric button. Students can add Questions to the created Supplementary Review questionnaire here.

4. Review Page

The students own supplementary questions are leading by a heading "Supplementary Review Questions".

5. Review Results Page

The supplementary review results will be showed to the team like other results.

== Use Cases ==

1. Use case of creating a Supplementary Review Questionnaire

2. Use case of reviewing questions for reviewers.

3. Use case of reviewing responses of questions.

== Test Plan ==

Actually, we need to add tests for the following:

1. To check the link for "Supplementary Review Questionnaire" appears in the "Your Work" section of a student.

2. To check if the link for "Supplementary Review Questionnaire" redirects to page which allows to create questionnaire.

3. To check if the questionnaire ID is stored in the Team table.

4. To check if the reviewers can see the supplementary questions that were added by the team as part of the review questions.

5. To check if the responses of the Supplementary Review Questions have been added to the responses of the existing review questions.

== File which are added/modified ==

Note: Because the pull request contains some code irrelevant to this project which make it confusing, we post our code here for you to read clearly.

== Team members ==
Hua Cao

Heng Yu

Jianshu Zhang

Zirun Han

== Links ==
Expertiza on Github:https://github.com/zyczyh/expertiza

Pull Request:https://github.com/expertiza/expertiza/pull/1325

Expertiza YouTube channel:https://youtu.be/3PUNknSbU-k

CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams

2019-11-11T01:46:00Z

Hyu22:

This wiki page is for the description of changes made under E1968 OSS assignment for Fall 2019, CSC/ECE 517.

== Background ==

This project fixed several bugs related to Assignment teams. Expertiza has Assignment objects, which represent an assignment usually assigned by an in structor for a course. If the instructor allowe teams for the assignment, the participants in that course can create teams with each other. Also, the instructor can create teams or add team membert to a exsiting team. Our project is focused on fixing bugs related to these functionalities.

== Problem Description ==

In this project we fixed three problems, the problems and the way to reproduce them is shown below. 
1. Adding a member from the UI (typing the ID into the textbox) raises an error.
Reproduciton:
(1)Login as an instructor.
(2)Go to Assignment tab under Manage.
(3)Click any assignment for example : OSS project & documentation.
(4)Select Create Teams.
(5)Select Add Team Member option for any team.
(6)Adding a member from the UI (typing the ID into the textbox) raises an error.
2. Impersonating a student who has an assignment without affiliating to any course will cause an error.
(1)Login as an instructor.
(2)Go to the Assignment tab under Manage.
(3)Click the "+" button and then create a new assignment named "E1968" without choosing any course from the course dropdown menu.
(4)Go back to the Assignment tab under Manage, and click the "Add participants" of the assignment of "E1968".
(5)Fill in the form "Enter a user login" with a student's name, for instance, "student7515".
(6)Go to the Impersonate User tab under Manage, fill in the form "Enter user account" with the student "student7515".
(7)Clicking the button "Impersonate" raises an error.
3. Creating a team by uploading a file.
(1)Login as an instructor.
(2)Go to Assignment tab under Manage.
(3)Click any assignment.
(4)Click Create Teams.
(5)Click Import Teams.
(6)Create teams by clicking the button "Import".

== Solutions ==

1. The reason for the first problem was actually due to a key error. In teams_users_controller.rb line 35, 'assignment_id' was used to find AssignmentParticipant. But in the model of AssignmentParticipant, the foreign key name is acctually 'parent_id'. So, by changing it, problem solved.
 [[File:Problem1change.png]] 
2. After our inspection into the file of "expertiza/app/controllers/student_task_controller.rb", we found the reason for the second problem was that before we used t.assignment.course.instructor_id, we had to confirm that t.assignment.course was not equal to nil. If there existed an assignment without being subject to any course, when this assignment was assigned to a specific student, it would raise an error when it came to showing the tasks of the student. Thus, in order to show student tasks correctly, we changed the code to at first checking whether the t.assignment.course was nil. If t.assignment was not nil, we could use t.assignment.course.instructor_id to retrieve data needed from the database, otherwise, we used t.assignment.instructor_id directly to retrieve data needed.
 [[File:problem2.jpg]] 
3. The third one works fine.

== Testing Details==

=== RSpec ===
For each of the problems, we did feature tests with Rspec. They all follows the reproduction steps decribed above.

=== Feature Testing ===
*Problem 1: assignment_team_member_spec.rb
Following steps needs to be performed to test this code: 
1. Login as instructor. 
2. Create a course and an assignment under that course. 
2. Add at least two students as participants to the assignment. 
3. Create a team for the assignment. 
4. Add a participant to the team. 
5. Check if the student is a team member of that team. 

*Problem 2: impersonate_student_spec.rb
Following steps needs to be performed to test this code: 
1. Create data for the test including an instructor, a student and an assignment without being subject to any course. 
2. Log in as instructor. 
3. Add the student as the participant of the assignment created. 
4. Impersonate the student from the instructor account. 
5. Check if the page of displaying tasks of the student is correctly shown. 

*Problem 3: assignment_team_import_spec.rb
Following steps needs to be performed to test this code: 
1. Login as instructor. 
2. Create a course and an assignment under that course. 
3. Create teams for the assignment by importing a file. 
4. Check if these teams belongs to the assignment. 

Run the test locally:
*Problem 1: The snapshot of results in the console when running rspec spec/features/assignment_team_member_spec.rb
[[File:Run_p1.png]] 
*Problem 2: The snapshot of results in the console when running rspec spec/features/impersonate_student_spec.rb
[[File:snapshot_of_console_in_E1968_problem_2.jpg]] 
According to above snapshot, after we applied changes in original code, the test was able to passed. Besides, we confirmed that our changes were successful by taking the same actions in our browser.

*Problem 3:The snapshot of results in the console when running rspec spec/features/assignment_team_import_spec.rb
[[File:issue3.png]]

CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams

2019-11-11T01:44:53Z

Hyu22:

== Background ==

This project fixed several bugs related to Assignment teams. Expertiza has Assignment objects, which represent an assignment usually assigned by an in structor for a course. If the instructor allowe teams for the assignment, the participants in that course can create teams with each other. Also, the instructor can create teams or add team membert to a exsiting team. Our project is focused on fixing bugs related to these functionalities.

== Problem Description ==

In this project we fixed three problems, the problems and the way to reproduce them is shown below. 
1. Adding a member from the UI (typing the ID into the textbox) raises an error.
Reproduciton:
(1)Login as an instructor.
(2)Go to Assignment tab under Manage.
(3)Click any assignment for example : OSS project & documentation.
(4)Select Create Teams.
(5)Select Add Team Member option for any team.
(6)Adding a member from the UI (typing the ID into the textbox) raises an error.
2. Impersonating a student who has an assignment without affiliating to any course will cause an error.
(1)Login as an instructor.
(2)Go to the Assignment tab under Manage.
(3)Click the "+" button and then create a new assignment named "E1968" without choosing any course from the course dropdown menu.
(4)Go back to the Assignment tab under Manage, and click the "Add participants" of the assignment of "E1968".
(5)Fill in the form "Enter a user login" with a student's name, for instance, "student7515".
(6)Go to the Impersonate User tab under Manage, fill in the form "Enter user account" with the student "student7515".
(7)Clicking the button "Impersonate" raises an error.
3. Creating a team by uploading a file.
(1)Login as an instructor.
(2)Go to Assignment tab under Manage.
(3)Click any assignment.
(4)Click Create Teams.
(5)Click Import Teams.
(6)Create teams by clicking the button "Import".

== Solutions ==

1. The reason for the first problem was actually due to a key error. In teams_users_controller.rb line 35, 'assignment_id' was used to find AssignmentParticipant. But in the model of AssignmentParticipant, the foreign key name is acctually 'parent_id'. So, by changing it, problem solved.
 [[File:Problem1change.png]] 
2. After our inspection into the file of "expertiza/app/controllers/student_task_controller.rb", we found the reason for the second problem was that before we used t.assignment.course.instructor_id, we had to confirm that t.assignment.course was not equal to nil. If there existed an assignment without being subject to any course, when this assignment was assigned to a specific student, it would raise an error when it came to showing the tasks of the student. Thus, in order to show student tasks correctly, we changed the code to at first checking whether the t.assignment.course was nil. If t.assignment was not nil, we could use t.assignment.course.instructor_id to retrieve data needed from the database, otherwise, we used t.assignment.instructor_id directly to retrieve data needed.
 [[File:problem2.jpg]] 
3. The third one works fine.

== Testing Details==

=== RSpec ===
For each of the problems, we did feature tests with Rspec. They all follows the reproduction steps decribed above.

=== Feature Testing ===
*Problem 1: assignment_team_member_spec.rb
Following steps needs to be performed to test this code: 
1. Login as instructor. 
2. Create a course and an assignment under that course. 
2. Add at least two students as participants to the assignment. 
3. Create a team for the assignment. 
4. Add a participant to the team. 
5. Check if the student is a team member of that team. 

*Problem 2: impersonate_student_spec.rb
Following steps needs to be performed to test this code: 
1. Create data for the test including an instructor, a student and an assignment without being subject to any course. 
2. Log in as instructor. 
3. Add the student as the participant of the assignment created. 
4. Impersonate the student from the instructor account. 
5. Check if the page of displaying tasks of the student is correctly shown. 

*Problem 3: assignment_team_import_spec.rb
Following steps needs to be performed to test this code: 
1. Login as instructor. 
2. Create a course and an assignment under that course. 
3. Create teams for the assignment by importing a file. 
4. Check if these teams belongs to the assignment. 

Run the test locally:
*Problem 1: The snapshot of results in the console when running rspec spec/features/assignment_team_member_spec.rb
[[File:Run_p1.png]] 
*Problem 2: The snapshot of results in the console when running rspec spec/features/impersonate_student_spec.rb
[[File:snapshot_of_console_in_E1968_problem_2.jpg]] 
According to above snapshot, after we applied changes in original code, the test was able to passed. Besides, we confirmed that our changes were successful by taking the same actions in our browser.

*Problem 3:The snapshot of results in the console when running rspec spec/features/assignment_team_import_spec.rb
[[File:issue3.png]]

CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams

2019-10-28T02:51:55Z

Hyu22: /* Solutions */

This wiki page is for the description of changes made under E1968 OSS assignment for Fall 2019, CSC/ECE 517.

== Background ==

This project fixed several bugs related to Assignment teams. Expertiza has Assignment objects, which represent an assignment usually assigned by an in structor for a course. If the instructor allowe teams for the assignment, the participants in that course can create teams with each other. Also, the instructor can create teams or add team membert to a exsiting team. Our project is focused on fixing bugs related to these functionalities.

== Problem Description ==

In this project we fixed three problems, the problems and the way to reproduce them is shown below. 
1. Adding a member from the UI (typing the ID into the textbox) raises an error.
Reproduciton:
(1)Login as an instructor.
(2)Go to Assignment tab under Manage.
(3)Click any assignment for example : OSS project & documentation.
(4)Select Create Teams.
(5)Select Add Team Member option for any team.
(6)Adding a member from the UI (typing the ID into the textbox) raises an error.
2. Impersonating a student who has an assignment without affiliating to any course will cause an error.
(1)Login as an instructor.
(2)Go to the Assignment tab under Manage.
(3)Click the "+" button and then create a new assignment named "E1968" without choosing any course from the course dropdown menu.
(4)Go back to the Assignment tab under Manage, and click the "Add participants" of the assignment of "E1968".
(5)Fill in the form "Enter a user login" with a student's name, for instance, "student7515".
(6)Go to the Impersonate User tab under Manage, fill in the form "Enter user account" with the student "student7515".
(7)Clicking the button "Impersonate" raises an error.
3. TODO 

== Solutions ==

1. The reason for the first problem was actually due to a key error. In teams_users_controller.rb line 35, 'assignment_id' was used to find AssignmentParticipant. But in the model of AssignmentParticipant, the foreign key name is acctually 'parent_id'. So, by changing it, problem solved.
 [[File:Problem1change.png]] 
2. After our inspection into the file of "expertiza/app/controllers/student_task_controller.rb", we found the reason for the second problem was that before we used t.assignment.course.instructor_id, we had to confirm that t.assignment.course was not equal to nil. If there existed an assignment without being subject to any course, when this assignment was assigned to a specific student, it would raise an error when it came to showing the tasks of the student. Thus, in order to show student tasks correctly, we changed the code to at first checking whether the t.assignment.course was nil. If t.assignment was not nil, we could use t.assignment.course.instructor_id to retrieve data needed from the database, otherwise, we used t.assignment.instructor_id directly to retrieve data needed.
 [[File:problem2.jpg]] 
3. TODO 

== Testing Details==

=== RSpec ===
For each of the problems, we did feature tests with Rspec. They all follows the reproduction steps decribed above.

=== Feature Testing ===
*Problem 1: assignment_team_member_spec.rb
Following steps needs to be performed to test this code: 
1. Login as instructor. 
2. Create a course and an assignment under that course. 
2. Add at least two students as participants to the assignment. 
3. Create a team for the assignment. 
4. Add a participant to the team. 
5. Check if the student is a team member of that team. 

*Problem 2: impersonate_student_spec.rb
Following steps needs to be performed to test this code: 
1. Create data for the test including an instructor, a student and an assignment without being subject to any course. 
2. Log in as instructor. 
3. Add the student as the participant of the assignment created. 
4. Impersonate the student from the instructor account. 
5. Check if the page of displaying tasks of the student is correctly shown. 

*Problem 3 TODO

Run the test locally:
TODO: the snapshot of console result of all test.
*Problem 2: The snapshot of results in the console when running rspec spec/features/impersonate_student_spec.rb
[[File:snapshot_of_console_in_E1968_problem_2.jpg]] 
According to above snapshot, after we applied changes in original code, the test was able to passed. Besides, we confirmed that our changes were successful by taking the same actions in our browser.

CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams

2019-10-28T02:48:55Z

2019-10-27T22:14:49Z

Hyu22: /* Problem Description */

CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams

2019-10-27T22:14:12Z

Hyu22: /* Problem Description */