Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-05-02T17:09:47Z

Hpullag: /* Test Plan Old */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:New Badge.png|center]]

== Adding Badges to Assignments ==

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.
[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:Awarded Badges.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb - Modification to display all available badges to badges tab as checkbox was done. Also a link to creating a new badge is provided
* expertiza/app/views/badges/new.html.erb - New file to create a new badge was added to this file
* expertiza/app/views/badges/_form.html.erb - New file to create a form for badge was added to this file
* expetiza/app/views/response/response.html.erb - Modification to display checkbox questions in review questioner was added to this file

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== Routes===
* Routes for badges was added

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have tested:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without a valid image name

Unit Tests were written for newly added code in the badges model.

New rspec file was added in spec/models/badge_spec.rb. Test cases were written to validate the different conditions of creating a new badge.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for a newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable instructors to do that would be useful

= References=

#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[https://youtu.be/GZrZTBlH7GQ Link to Screen-cast of out implementation]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T02:59:17Z

Hpullag: /* References */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:New Badge.png|center]]

== Adding Badges to Assignments ==

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.
[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:Awarded Badges.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb - Modification to display all available badges to badges tab as checkbox was done. Also a link to creating a new badge is provided
* expertiza/app/views/badges/new.html.erb - New file to create a new badge was added to this file
* expertiza/app/views/badges/_form.html.erb - New file to create a form for badge was added to this file
* expetiza/app/views/response/response.html.erb - Modification to display checkbox questions in review questioner was added to this file

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== Routes===
* Routes for badges was added

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for a newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable instructors to do that would be useful

= References=

#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[https://youtu.be/GZrZTBlH7GQ Link to Screen-cast of out implementation]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:47:40Z

Hpullag: /* Visibility of assigned badges to Students */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:New Badge.png|center]]

== Adding Badges to Assignments ==

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.
[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:Awarded Badges.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb - Modification to display all available badges to badges tab as checkbox was done. Also a link to creating a new badge is provided
* expertiza/app/views/badges/new.html.erb - New file to create a new badge was added to this file
* expertiza/app/views/badges/_form.html.erb - New file to create a form for badge was added to this file
* expetiza/app/views/response/response.html.erb - Modification to display checkbox questions in review questioner was added to this file

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== Routes===
* Routes for badges was added

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for a newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable instructors to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

File:Awarded Badges.png

2018-04-29T01:47:14Z

Hpullag:

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:32:20Z

Hpullag: /* Creation of new badges */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:New Badge.png|center]]

== Adding Badges to Assignments ==

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.
[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb - Modification to display all available badges to badges tab as checkbox was done. Also a link to creating a new badge is provided
* expertiza/app/views/badges/new.html.erb - New file to create a new badge was added to this file
* expertiza/app/views/badges/_form.html.erb - New file to create a form for badge was added to this file
* expetiza/app/views/response/response.html.erb - Modification to display checkbox questions in review questioner was added to this file

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== Routes===
* Routes for badges was added

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:32:07Z

Hpullag: /* Creation of new badges */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:New Badge.png]]

== Adding Badges to Assignments ==

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.
[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb - Modification to display all available badges to badges tab as checkbox was done. Also a link to creating a new badge is provided
* expertiza/app/views/badges/new.html.erb - New file to create a new badge was added to this file
* expertiza/app/views/badges/_form.html.erb - New file to create a form for badge was added to this file
* expetiza/app/views/response/response.html.erb - Modification to display checkbox questions in review questioner was added to this file

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== Routes===
* Routes for badges was added

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

File:New Badge.png

2018-04-29T01:31:35Z

Hpullag:

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:31:22Z

Hpullag: /* Creation of new badges */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

== Adding Badges to Assignments ==

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.
[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb - Modification to display all available badges to badges tab as checkbox was done. Also a link to creating a new badge is provided
* expertiza/app/views/badges/new.html.erb - New file to create a new badge was added to this file
* expertiza/app/views/badges/_form.html.erb - New file to create a form for badge was added to this file
* expetiza/app/views/response/response.html.erb - Modification to display checkbox questions in review questioner was added to this file

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== Routes===
* Routes for badges was added

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:28:20Z

Hpullag: /* Files modified */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb - Modification to display all available badges to badges tab as checkbox was done. Also a link to creating a new badge is provided
* expertiza/app/views/badges/new.html.erb - New file to create a new badge was added to this file
* expertiza/app/views/badges/_form.html.erb - New file to create a form for badge was added to this file
* expetiza/app/views/response/response.html.erb - Modification to display checkbox questions in review questioner was added to this file

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== Routes===
* Routes for badges was added

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:26:31Z

Hpullag: /* New Files */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb - Modification to display all available badges to badges tab as checkbox was done. Also a link to creating a new badge is provided
* expertiza/app/views/badges/new.html.erb - New file to create a new badge was added to this file
* expertiza/app/views/badges/_form.html.erb - New file to create a form for badge was added to this file
* expetiza/app/views/response/response.html.erb - Modification to display checkbox questions in review questioner was added to this file

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:26:17Z

Hpullag: /* Views */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb - Modification to display all available badges to badges tab as checkbox was done. Also a link to creating a new badge is provided
* expertiza/app/views/badges/new.html.erb - New file to create a new badge was added to this file
* expertiza/app/views/badges/_form.html.erb - New file to create a form for badge was added to this file
* expetiza/app/views/response/response.html.erb - Modification to display checkbox questions in review questioner was added to this file

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:17:05Z

Hpullag: /* Models */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/assignment_badge.rb - create badges without threshold method was added
* expertiza/app/models/assignment_form.rb - update assigned badges method was added. this method modifies the db entries for assignment_badges table based on the checkbox entries
* expertiza/app/models/awarded_badge.rb - suggest badge method was added, which is called when badge is suggested by student by checking the checkbox in questioner.
* expertiza/app/models/badge.rb - functionality to get image name from name was added

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:06:51Z

Hpullag: /* Files modified */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses from checkbox about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T01:05:20Z

Hpullag: /* Files modified */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/assignments_controller.rb - Modifications were done to include the functionality of displaying all badges in the badges tab and check box based selection process
* expertiza/app/controllers/badges_controller.rb - This was a new file added in this implementation . Code on handling new badge creation, in create method was added.
* expertiza/app/controllers/response_controller.rb - Modification to process question responses about badges were added to this file

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T00:54:21Z

Hpullag: /* Design Description */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps taken during the course of this project. Two major flows exist in this project , one being new badge creation and associating them with the assignment. Second one is modifying the flow for good teammate and reviewer badges to be present in appropriate question section.

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T00:50:26Z

Hpullag: /* Problem Statement */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image and letting the instructor add them to the assignment
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T00:47:37Z

Hpullag: /* Creation of new badges */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save, entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T00:46:30Z

Hpullag: /* Design Description */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg|center]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png|center]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T00:45:59Z

Hpullag: /* Design Description */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[[File:Badges list.png]]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-29T00:45:34Z

Hpullag: /* Creation of new badges */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

[File:Badges list.png]

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

File:Badges list.png

2018-04-29T00:44:50Z

Hpullag:

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-28T22:21:24Z

Hpullag: /* Files modified */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

=Implementation Details=
== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-28T22:17:38Z

Hpullag: /* Creation of new badges */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. The view is changed to display all the available badges and a check box to select each of them. It was initially present as a badge vs threshold display. Once the user clicks save entries are modified in the data base.

To add a new badge which is a new functionality, we display a button, at the end of the badges tab, which redirects the user to a page enabling him to create a New badge. The new form fields include ''Badge Name'', ''Image'' and ''Description''. Upon saving the user is again redirected back to the earlier assignments display display.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-28T21:56:17Z

Hpullag: /* References */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1176 Pull Request for present implementation]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T22:13:03Z

Hpullag: /* Future Work */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI. A separate flow to enable the user to do that would be useful

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T22:11:12Z

Hpullag: /* Future Work */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
#The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. Workflow to change the status by the instructor must be implemented.
#There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
#Instructors cannot directly assign “Good Reviewer” badge through the UI.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T22:06:44Z

Hpullag: /* Future Work */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =
The approval workflow is currently missing - when a student assigns a badge to a peer, the approval status is set to 0 and it will never appear in the other student’s homepage. This needs to be implemented.
There is currently no way for any newly created badge to be assigned to a student through the UI, even if it has been added to an assignment. This needs to be implemented.
Instructors cannot directly assign “Good Reviewer” badge through the UI.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T22:04:10Z

Hpullag: /* Files to be modified */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T22:03:09Z

Hpullag: /* Approval of badges by instructor */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. A db migrate was run to include this column.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T22:01:29Z

Hpullag: /* Assignment of "Good Reviewer" badges by student */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Reviewer-badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

File:Reviewer-badge.png

2018-04-27T22:01:06Z

Hpullag:

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T22:00:29Z

Hpullag: /* Assignment of "Good Reviewer" badges by student */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

[[File:Teammate badge.png|center|]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

File:Teammate badge.png

2018-04-27T22:00:03Z

Hpullag:

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T21:57:37Z

Hpullag: /* Assignment of "Good Reviewer" badges by student */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

#Allowing Instructor to create new badges - which involves adding name and badge image.
#Students must be able to suggest "Good Teammate" badges during the teammate review periods.
#Students must be able to suggest "Good Reviewer" badges, for reviews received.
#Create a pipeline to enable instructor to manually approve badges suggested by students

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Design Description =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of this badges is done automatically based on a threshold, which is set during assignment creation. The score is calculated based on answers to questions on the review page.

In this implementation, the earlier flow was changed to allow participant to be able to suggest these badges to their fellow students. To enable this process, a new question in the format of a checkbox, was added into the teammate review questionnaire. This question appears after the Additional Comments section.

Upon selection of this check box an entry is made into the assigned badges table with the participant id and approval status being 0, implying that it is pending with the instructor, for approval before displaying.

[[File:Team_mate_review_new.png|center|]]

== Assignment of "Good Reviewer" badges by student ==

Similar to Good Teammate badge, in the existing workflow, good reviewer was also assigned based on score and threshold. This is modified in our implementation, in a similar way as that of teammate badge. We add a "Good Reviewer check box" as a question in the feedback of the reviews given page. An entry is made to the awarded badges table with the approval status as 0. Once this field is changed to 1, it would display badges in the assignment row .

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T21:45:03Z

Hpullag: /* Implementation Plan */

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T21:42:31Z

Hpullag: /* Assignment of "Good Teammate" badges by student */

File:Team mate review new.png

2018-04-27T21:35:30Z

Hpullag: uploaded a new version of "File:Team mate review new.png"

File:Team mate review new.png

2018-04-27T21:34:56Z

Hpullag:

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T21:33:49Z

Hpullag: /* Assignment of "Good Teammate" badges by student */

File:Team mate review.png

2018-04-27T21:31:52Z

Hpullag: uploaded a new version of "File:Team mate review.png"

Team mate badge review location

File:Team mate review.png

2018-04-27T21:30:54Z

Hpullag: uploaded a new version of "File:Team mate review.png"

Team mate badge review location

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T21:30:19Z

Hpullag: /* Assignment of "Good Teammate" badges by student */

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T21:14:21Z

Hpullag: /* Assignment of "Good Teammate" badges by student */

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T21:00:31Z

Hpullag: /* Problem Statement */

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T20:59:59Z

Hpullag: /* Problem Statement */

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T20:59:46Z

Hpullag: /* Problem Statement */

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T20:58:39Z

Hpullag: /* Problem Statement */

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T20:58:17Z

Hpullag: /* Problem Statement */

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T20:47:25Z

Hpullag: /* Assignment of "Good Reviewer" badges */

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-27T20:44:32Z

Hpullag: /* Test Plan */

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

4. All badges assigned, must require the approval of the instructor, who would manually accept/deny them before final posting.

= Background And Motivation =

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

==Motivation==

The primary motivation behind this project is to give more flexibility to the instructor to assign badges instead of relying solely on automatic scoring. Also, allowing students to suggest ''Good Teammate'' and ''Good Reviewer'' badges for their peers will give them an incentive to put in more effort towards carefully reviewing other's work, and encourage them to actively participate in team projects.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
* expertiza/app/controllers/badge_controller.rb (to be added)

=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= Future Work =

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]