CSC/ECE 517 Fall 2017/E17AA Nomination for Badges: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(30 intermediate revisions by 3 users not shown)
Line 7: Line 7:
These are the pre-conditions that needs to hold true for each functionality to work
These are the pre-conditions that needs to hold true for each functionality to work


:· The maximum number of students that can be assigned to the project cannot be more then 1.  
:· The maximum number of students that can be assigned to the project cannot be more than 1.  
:· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.  
:· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.  
For students to be able to nominate badged without justification only if the project does not have a mandatory justification requirement.
Students can nominate for badges without providing a justification only if the instructor has not kept the justification field mandatory.


==Implementation Steps==
==Implementation Steps==


:· Provide professors an option to add all possible badges to a project.  
:· Provide professors an option to add all possible badges to a project.
:· Also provide the professor an option to make the justification field mandatory or not.
:· Allow students to nominate badges while peer reviewing.
:· Allow students to nominate badges while peer reviewing.
:· Show a summary of all nominated badges to professor in a single page.
:· Show a summary of all nominated badges to professor in a single page.
Line 20: Line 21:


*Files to be Modified
*Files to be Modified
:· Add the code to include the selection of relevant badges and the justification text box Assignment_badges_controller.rb.
:· Add the badges model to assignment_questionnaire.rb.
:· Add the code to display the nomination summary on the page student_task/list page
*Tables to be Modified
:· We’ll be creating a table named “badges”, with the following attributes:
  id: primary key
  name: varchar
  description: varchar
:· We’ll be creating a table named “assignment_questionnaires_badges”, with the following attributes:
  Id: Primary key
  assignment_id: foreign key
  questionnaire_id: foreign key
  badge_id: foreign key
==Execution Flow==
  [[File:Oodd5.PNG]]
Once the instructor logs in, they can either select badges for existing assignments or go to a view which displays all the nominations.
Once the instructor selects the badges for the existing assignments, the students can login and provide nominations for badges during peer review.
==Design==
  [[File:Oodd2.PNG]]
An instructor can add a badge to the badges table which will be also added to an assignment table as a probable nomination badge. The instructor can also view all the nominations done by the students during the peer review of an assignment.
The students on the other hand, while doing the peer review, can provide nominations for badges provided by the instructor for a particular assignment.
==Snapshots==
Note: Currently the images contain dummy data because the data will be available from the project [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2_Lightweight_Badging_System E17A2]
Below are the changes which are planned:
:·Added a new icon to the assignments which will redirect to a summary of the nominations for the assignment
  [[File:Summary_Icon.PNG]]
:·The new view for the instructor where the instructor can see the list of nominations for the assignment (This will be in the path /assignments/:id/nominations)
  [[File:New_View_For_Instructor.PNG]]
:·The instructor can decide whether to keep the justification mandatory or not. This will be added under the review strategy tab.
  [[File:Instructor_Review_Strategy.jpg]]
:·The instructor can decide which badges to be allowed for nomination for the assignment from the list of all the available badges. Multiple selection is possible. This has been added as a new tab called "Available Badges for Nominations"
  [[File:Nominations_Tab.PNG]]
  [[File:Bades_List.PNG]]
==Test Plan==
We will be creating test cases in the files
:·peer review.rb :Check with peer reviewer will be able to nominate badges
:·review_assignment_spec.rb:Check whether user is able to review assignment with Team Size=1
:·team_creation_spec.rb:Check the Team Size
:·review_mapping_spec.rb:Check whether reviewer is correctly mapped to the enrolled course
:·Write feature tests to verify the modifications:Include tests in the a new badge_system_spec.rb file in the spec/features directory
*UI design Testing:
:·Check if peer reviewer is able to nominate for badges with drop down list and contains text boxes for justification.
:·Check if instructor is able to view the summary of all nominations.
:·Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.
==Reference Links==
*[https://github.com/expertiza/expertiza/tree/master/app/views Expertiza Github Master Branch]
*[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2015_E1575_Share_the_data_in_Expertiza_to_a_remote_server_via_PRML_format Expertiza Database Schema]
*[https://www.youtube.com/watch?v=CnY9j_Dpjtg&feature=youtu.be Demo Video Link]

Latest revision as of 19:24, 6 December 2017

Problem Statement

The purpose of the project is to implement a way to allow students to nominate badges to other students while reviewing their work. The professor should also be able to see the nominations to each student in a single page.

Pre-Conditions

These are the pre-conditions that needs to hold true for each functionality to work

· The maximum number of students that can be assigned to the project cannot be more than 1.
· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.
· Students can nominate for badges without providing a justification only if the instructor has not kept the justification field mandatory.

Implementation Steps

· Provide professors an option to add all possible badges to a project.
· Also provide the professor an option to make the justification field mandatory or not.
· Allow students to nominate badges while peer reviewing.
· Show a summary of all nominated badges to professor in a single page.

Modifications To Be Done

  • Files to be Modified
· Add the code to include the selection of relevant badges and the justification text box Assignment_badges_controller.rb.
· Add the badges model to assignment_questionnaire.rb.
· Add the code to display the nomination summary on the page student_task/list page
  • Tables to be Modified
· We’ll be creating a table named “badges”, with the following attributes:
  id: primary key
  name: varchar
  description: varchar
· We’ll be creating a table named “assignment_questionnaires_badges”, with the following attributes:
  Id: Primary key
  assignment_id: foreign key
  questionnaire_id: foreign key
  badge_id: foreign key

Execution Flow

 

Once the instructor logs in, they can either select badges for existing assignments or go to a view which displays all the nominations.

Once the instructor selects the badges for the existing assignments, the students can login and provide nominations for badges during peer review.

Design

 

An instructor can add a badge to the badges table which will be also added to an assignment table as a probable nomination badge. The instructor can also view all the nominations done by the students during the peer review of an assignment.

The students on the other hand, while doing the peer review, can provide nominations for badges provided by the instructor for a particular assignment.

Snapshots

Note: Currently the images contain dummy data because the data will be available from the project E17A2

Below are the changes which are planned:

·Added a new icon to the assignments which will redirect to a summary of the nominations for the assignment
 
·The new view for the instructor where the instructor can see the list of nominations for the assignment (This will be in the path /assignments/:id/nominations)
 
·The instructor can decide whether to keep the justification mandatory or not. This will be added under the review strategy tab.
 
·The instructor can decide which badges to be allowed for nomination for the assignment from the list of all the available badges. Multiple selection is possible. This has been added as a new tab called "Available Badges for Nominations"
 


 

Test Plan

We will be creating test cases in the files

·peer review.rb :Check with peer reviewer will be able to nominate badges
·review_assignment_spec.rb:Check whether user is able to review assignment with Team Size=1
·team_creation_spec.rb:Check the Team Size
·review_mapping_spec.rb:Check whether reviewer is correctly mapped to the enrolled course
·Write feature tests to verify the modifications:Include tests in the a new badge_system_spec.rb file in the spec/features directory
  • UI design Testing:
·Check if peer reviewer is able to nominate for badges with drop down list and contains text boxes for justification.
·Check if instructor is able to view the summary of all nominations.
·Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.

Reference Links