feat: default grade designations configurable from settings #32406

kaustavb12 · 2023-06-09T05:53:43Z

Description

Currently a maximum of 5 grade cutoffs are configurable from the Grading Settings in Studio.
However, some universities might require more that 5 cutoffs depending on their grading policy.

Also, when a new grade cutoff is added, a default grade desgination is assigned to this cufoff. These default grade designations are hard coded in the javascript code. This means, if the maximum number of grade cutoff are to be increased, more default grade designations also need to be defined.

This PR address this issue.

In this PR, a new setting DEFAULT_GRADE_DESIGNATIONS is introduced which can be used to define the pass grade designations. This has a default value of ['A', 'B', 'C', 'D'], which is the current default.

The maximum number of grade cutoffs is now dependent on the length of the grade designations list, instead of being hard-coded to 5.

As before, the failure grade designation is always set to F which cannot be changed and is not to be included in the DEFAULT_GRADE_DESIGNATIONS list.

Ex. If there is a need to configure 7 grade cutoffs instead of the default 5, the following setting can be used:

DEFAULT_GRADE_DESIGNATIONS = ['A+', 'A', 'B+', 'B', 'C', 'D']

The DEFAULT_GRADE_DESIGNATIONS list must have more than 1 desginations, otherwise the default grade designations falls back to ['A', 'B', 'C', 'D'].

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

Default Scenario

Start studio in devstack using the PR branch
Open an exisiting course or create a new one.
Go to Settings --> Grading
Click on the + button repeatedly to add new grade cutoffs
Verify that maximum 5 grade cutoff designations are configurable with the values 'A', 'B', 'C', 'D' and 'F'

Modify Grade Designations

Add this to cms\envs\devstack.py : DEFAULT_GRADE_DESIGNATIONS = ['A+', 'A', 'B+', 'B', 'C', 'D']
Start studio in devstack using the PR branch
Open an exisiting course or create a new one.
Go to Settings --> Grading
Click on the + button repeatedly to add new grade cutoffs
Verify that maximum 7 grade cutoff designations are configurable with the values 'A+', 'A', 'B+', 'B', 'C', 'D' and 'F'

Grade Designations Fallback

Add this to cms\envs\devstack.py : DEFAULT_GRADE_DESIGNATIONS = ['A+']
Start studio in devstack using the PR branch
Open an exisiting course or create a new one.
Go to Settings --> Grading
Click on the + button repeatedly to add new grade cutoffs
Verify that maximum 5 grade cutoff designations are configurable with the values 'A', 'B', 'C', 'D' and 'F'

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

Other information

OpenCraft internal ticket : BB-7378

openedx-webhooks · 2023-06-09T05:53:48Z

Thanks for the pull request, @kaustavb12! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

keithgg · 2023-06-10T09:23:05Z

cms/static/js/views/settings/grading.js

@@ -314,7 +315,7 @@ function(ValidatingView, _, $, ui, GraderView, StringUtils, HtmlUtils) {
        addNewGrade: function(e) {
            e.preventDefault();
            var gradeLength = this.descendingCutoffs.length; // cutoffs doesn't include fail/f so this is only the passing grades
-            if (gradeLength > 3) {
+            if (gradeLength > this.GRADES.length - 1) {


@kaustavb12 could be a dumb question, but is there a possibility of this.GRADES being undefined if this line is invoked?

Eg. if options.gradeDesignations == 0 then these lines will trigger an error:

this.setupGradeDesignations([]) this.addNewGrade()

@keithgg

Great question.

We already have a default value of this.GRADES, therefore I feel the chances of this.GRADES being undefined is slim.

The place which is most likely to break with an erroneous value of options.gradeDesignations is the length check in the setupGradeDesignations method. Although, for most scenarios, such as passing an intereger, strings, empty arrays etc., this seems to be handled elegently by the browser and nothing breaks. Only explicitly passing None/null seems to break this.

To mitigate that, I have now added a check to verify that gradeDesignations is infact a valid array. This seems to handle those edge cases I mentioned above.

keithgg

@kaustavb12 LGTM 👍

I read through the code
I confirmed that I could replicate the test instructions

mphilbrick211 · 2023-06-28T18:40:41Z

Hi @jmakowski1123 - checking on this one to see if it should go through Product review?

mphilbrick211 · 2023-08-23T01:53:38Z

Hi @jmakowski1123! Any update on this?

jmakowski1123 · 2023-08-25T17:17:49Z

Product Feature Ticket is ready for product review: https://github.com/orgs/openedx/projects/4/views/20

kaustavb12 · 2024-01-07T10:31:59Z

@mphilbrick211

I believe this feature now has product approval and I have made the changes requested there.

Are we good to move this PR to review now ?

mphilbrick211 · 2024-01-11T16:20:49Z

Thanks for flagging, @kaustavb12! I've sent this over to @openedx/2u-arch-bom to take a look at.

kaustavb12 · 2024-03-06T13:57:49Z

@mphilbrick211 Just checking to see, could this ticket be CC reviewed ?

timmc-edx · 2024-03-06T15:23:55Z

Sorry, looks like we didn't end up routing this properly. @openedx/2u-tnl can you take a look?

farhaanbukhsh · 2024-03-30T05:48:12Z

@mphilbrick211 I can help to review this PR 😇

mphilbrick211 · 2024-04-02T18:01:23Z

@mphilbrick211 I can help to review this PR 😇

Thank you so much, @farhaanbukhsh!

0x29a · 2024-04-10T09:28:39Z

@farhaanbukhsh, @kaustavb12, if I'm not mistaken, we have around two weeks before the Redwood release cut. It'd be really awesome if we could get this PR reviewed and merged before the cut.

cms/djangoapps/contentstore/rest_api/v1/views/grading.py

farhaanbukhsh

@kaustavb12 apart from the clarification everything looks good, Kudos on the work.

kaustavb12 · 2024-05-02T11:03:12Z

@farhaanbukhsh

Thanks a lot for the review.

Review comment addressed. I have also rebased and squashed the commits.

farhaanbukhsh · 2024-05-02T12:33:08Z

jenkins run all

farhaanbukhsh

👍

✅ I tested this on devstack and it works perfectly
✅ I read through the code
❌ I checked for accessibility issues
❌ Includes documentation
❌ I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository.

farhaanbukhsh · 2024-05-07T15:24:18Z

@kaustavb12 can you rebase the PR, thanks :)

kaustavb12 · 2024-05-07T15:31:09Z

@farhaanbukhsh Rebased and Squashed

openedx-webhooks · 2024-05-07T19:44:06Z

@kaustavb12 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-pipeline-bot · 2024-05-07T23:34:08Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2024-05-08T00:04:07Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2024-05-08T00:04:07Z

2U Release Notice: This PR has been deployed to the edX production environment.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 9, 2023

kaustavb12 force-pushed the kaustav/default_grade_designations branch from c3428c8 to 59e3957 Compare June 9, 2023 06:30

keithgg reviewed Jun 10, 2023

View reviewed changes

kaustavb12 force-pushed the kaustav/default_grade_designations branch from a399053 to 376514b Compare June 11, 2023 14:27

keithgg approved these changes Jun 11, 2023

View reviewed changes

kaustavb12 force-pushed the kaustav/default_grade_designations branch from 376514b to 7a7af8c Compare June 11, 2023 15:28

kaustavb12 mentioned this pull request Jun 11, 2023

feat: default grade designations configurable from settings open-craft/edx-platform#541

Merged

xitij2000 mentioned this pull request Jun 27, 2023

OpenCraft Palm.1 Release Branch open-craft/edx-platform#543

Merged

jmakowski1123 mentioned this pull request Aug 25, 2023

Grading Enhancement: default grade designations configurable from settings openedx/platform-roadmap#281

Open

7 tasks

mphilbrick211 added the product review PR requires product review before merging label Aug 29, 2023

0x29a mentioned this pull request Dec 31, 2023

feat: port code drift for open-craft/edx-platform [BB-8366] open-craft/edx-platform#614

Merged

kaustavb12 force-pushed the kaustav/default_grade_designations branch 2 times, most recently from 1574512 to a57f5fb Compare January 7, 2024 10:24

mphilbrick211 added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Jan 11, 2024

mphilbrick211 assigned farhaanbukhsh Apr 2, 2024

mphilbrick211 requested a review from farhaanbukhsh April 2, 2024 18:02

mphilbrick211 added product review complete PR has gone through product review and removed product review PR requires product review before merging labels Apr 2, 2024

farhaanbukhsh reviewed May 1, 2024

View reviewed changes

cms/djangoapps/contentstore/rest_api/v1/views/grading.py Show resolved Hide resolved

farhaanbukhsh requested changes May 1, 2024

View reviewed changes

kaustavb12 force-pushed the kaustav/default_grade_designations branch from cb99549 to 5911cbf Compare May 2, 2024 11:00

kaustavb12 force-pushed the kaustav/default_grade_designations branch 2 times, most recently from 32e10d0 to 851dafa Compare May 3, 2024 10:48

farhaanbukhsh approved these changes May 7, 2024

View reviewed changes

feat: default grade designations configurable from settings

218a010

kaustavb12 force-pushed the kaustav/default_grade_designations branch from 851dafa to 218a010 Compare May 7, 2024 15:30

farhaanbukhsh merged commit d43a2f7 into openedx:master May 7, 2024
79 checks passed

farhaanbukhsh deleted the kaustav/default_grade_designations branch May 7, 2024 19:44

itsjeyd removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label May 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: default grade designations configurable from settings #32406

feat: default grade designations configurable from settings #32406

kaustavb12 commented Jun 9, 2023 •

edited

Loading

openedx-webhooks commented Jun 9, 2023 •

edited

Loading

keithgg Jun 10, 2023

kaustavb12 Jun 11, 2023 •

edited

Loading

keithgg left a comment

mphilbrick211 commented Jun 28, 2023

mphilbrick211 commented Aug 23, 2023

jmakowski1123 commented Aug 25, 2023

kaustavb12 commented Jan 7, 2024

mphilbrick211 commented Jan 11, 2024

kaustavb12 commented Mar 6, 2024 •

edited

Loading

timmc-edx commented Mar 6, 2024

farhaanbukhsh commented Mar 30, 2024 •

edited

Loading

mphilbrick211 commented Apr 2, 2024

0x29a commented Apr 10, 2024

farhaanbukhsh left a comment

kaustavb12 commented May 2, 2024 •

edited

Loading

farhaanbukhsh commented May 2, 2024

farhaanbukhsh left a comment

farhaanbukhsh commented May 7, 2024

kaustavb12 commented May 7, 2024

openedx-webhooks commented May 7, 2024

edx-pipeline-bot commented May 7, 2024

edx-pipeline-bot commented May 8, 2024

edx-pipeline-bot commented May 8, 2024

feat: default grade designations configurable from settings #32406

feat: default grade designations configurable from settings #32406

Conversation

kaustavb12 commented Jun 9, 2023 • edited Loading

Description

Supporting information

Testing instructions

Default Scenario

Modify Grade Designations

Grade Designations Fallback

Deadline

Other information

openedx-webhooks commented Jun 9, 2023 • edited Loading

keithgg Jun 10, 2023

Choose a reason for hiding this comment

kaustavb12 Jun 11, 2023 • edited Loading

Choose a reason for hiding this comment

keithgg left a comment

Choose a reason for hiding this comment

mphilbrick211 commented Jun 28, 2023

mphilbrick211 commented Aug 23, 2023

jmakowski1123 commented Aug 25, 2023

kaustavb12 commented Jan 7, 2024

mphilbrick211 commented Jan 11, 2024

kaustavb12 commented Mar 6, 2024 • edited Loading

timmc-edx commented Mar 6, 2024

farhaanbukhsh commented Mar 30, 2024 • edited Loading

mphilbrick211 commented Apr 2, 2024

0x29a commented Apr 10, 2024

farhaanbukhsh left a comment

Choose a reason for hiding this comment

kaustavb12 commented May 2, 2024 • edited Loading

farhaanbukhsh commented May 2, 2024

farhaanbukhsh left a comment

Choose a reason for hiding this comment

farhaanbukhsh commented May 7, 2024

kaustavb12 commented May 7, 2024

openedx-webhooks commented May 7, 2024

edx-pipeline-bot commented May 7, 2024

edx-pipeline-bot commented May 8, 2024

edx-pipeline-bot commented May 8, 2024

kaustavb12 commented Jun 9, 2023 •

edited

Loading

openedx-webhooks commented Jun 9, 2023 •

edited

Loading

kaustavb12 Jun 11, 2023 •

edited

Loading

kaustavb12 commented Mar 6, 2024 •

edited

Loading

farhaanbukhsh commented Mar 30, 2024 •

edited

Loading

kaustavb12 commented May 2, 2024 •

edited

Loading