[Feature:RainbowGrades] Add show_notes control to Rainbow Grades by jndlansh · Pull Request #12757 · Submitty/Submitty

jndlansh · 2026-04-07T07:29:01Z

Why is this Change Important & Necessary?

Closes #12753
Rainbow Grades configuration now supports the show_notes field that was added to config.json, but it was not accessible via the Web UI. This PR exposes the field in the Rainbow Grades Configuration page, allowing instructors to configure notes visibility per gradeable without manually editing JSON.

What is the New Behavior?

New "Notes visibility" dropdown appears for each Numeric/Text and Checkpoint gradeable in the Gradeables section
Dropdown options: never (default), instructor_only, student_only, student_and_instructor
Dropdown is only visible when "Show Category/Gradeable Configuration" toggle is ON, minimizing UI clutter
Electronic File gradeables do not show this control (not applicable)
Selections persist in gui_customization.json with the show_notes field per gradeable

What steps should a reviewer take to reproduce or test?

Navigate to Rainbow Grades Configuration page
In the Gradeables section, toggle "Show Category/Gradeable Configuration" ON
Verify "Notes visibility" dropdown appears below Numeric and Checkpoint gradeable titles
Change dropdown values and confirm status shows "All changes saved"
Refresh the page—selections should persist
Download GUI Customization and verify JSON contains "show_notes" fields with selected values

Automated Testing & Documentation

Existing Rainbow Grades test suite covers page load and general functionality. New Cypress test case recommended to specifically assert show_notes dropdown visibility and persistence (separate GitHub issue).

Other information

Not a breaking change + backward compatible (defaults to "never" if not specified)
No database migrations required
No security concerns

Eli-J-Schwartz

I performed a simple functionality review of this PR. When I toggled "Show Category/Gradeable Configuration", the dropdown menus appeared on applicable gradables, as seen in the screenshot below:

Then, when I downloaded the GUI customization files, the selections appeared as I submitted for requested gradables:

I took at the code as well, and it looks good, with no obvious bugs as far as I can tell.

Eli-J-Schwartz · 2026-04-07T18:44:44Z

Just noticed that this solves the same issue as #12756. Only one should be merged.

codecov · 2026-04-07T18:45:01Z

Codecov Report

❌ Patch coverage is 33.33333% with 32 lines in your changes missing coverage. Please review.
✅ Project coverage is 21.68%. Comparing base (749e6a4) to head (abc143f).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #12757      +/-   ##
============================================
+ Coverage     21.66%   21.68%   +0.01%     
- Complexity     9754     9778      +24     
============================================
  Files           268      268              
  Lines         36457    36504      +47     
  Branches        487      487              
============================================
+ Hits           7900     7915      +15     
- Misses        28074    28106      +32     
  Partials        483      483

Flag	Coverage Δ
autograder	`21.32% <ø> (ø)`
js	`2.04% <ø> (ø)`
migrator	`100.00% <ø> (ø)`
php	`20.71% <33.33%> (+0.01%)`	⬆️
python_submitty_utils	`80.08% <ø> (ø)`
submitty_daemon_jobs	`91.13% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

jndlansh · 2026-04-07T19:04:05Z

Thank you @Eli-J-Schwartz!
I have addressed the Linting issues.

JManion32 · 2026-04-07T21:53:06Z

@jndlansh Please review #12756, which is solving the same issue.

bmcutler · 2026-04-08T02:42:54Z

@jndlansh

Thanks for the PR and including screenshots. I think the interface is overwhelming to show those options -- most instructors will not use this feature. Let's add an additional toggle next to "extra credit" and "remove lowest" that says "customize show notes" (or something similar, does anyone have a better description?). Anyway, let's only display those show notes drop down options if the user has enabled show gradeable configuration AND customize show notes.

NOTE: I made the same comment on the other PR solving this issue. We can only merge one of these PRs, please work together to make the best software. Thanks.

jndlansh · 2026-04-08T03:13:43Z

Thank you so much @bmcutler!
I have added the required toggle. Yes I and @GarvitKhandelwal31 shall work together, but since he has already helped me massively in other PRs, it would be great to continue working in this PR or as you and garvit like.

GarvitKhandelwal31 · 2026-04-08T15:44:19Z

Hey @jndlansh can we add Cypress test that verifies the show notes dropdowns are hidden until both Show Category/Gradeable Configuration (or in accordance with the latest changes in your branch) and that a changed value persists after refresh and is reflected in the downloaded GUI customization JSON.
I did not test the UI, but since @Eli-J-Schwartz have already tested it should be solid.

jndlansh · 2026-04-08T17:58:50Z

@GarvitKhandelwal31 I have extended the rainbow_grading.spec.js file to add the new test: "Show Notes options require both toggles and persist to GUI JSON". It passed my local testing. Since you and I are working together on this PR/Issue it is good to add the test directly to verify the new functionality and UI betterments introduced by this PR.

GarvitKhandelwal31 · 2026-04-09T09:23:41Z

Screen.Recording.2026-04-09.145125.mp4

New UI notes visibility check box state is not persisted. Controls always come back hidden after refresh even when custom values already exist.

GarvitKhandelwal31 · 2026-04-09T09:41:03Z

+        // Refresh and verify selected value persists.
+        cy.reload();
+        cy.get('#config-toggle').check({ force: true }).should('be.checked');
+        cy.get('#customize_show_notes_checkbox').check({ force: true }).should('be.checked');


After the persistence check done here, ensure we reset the course state that was changed in lines 171-185.

jndlansh · 2026-04-09T20:53:01Z

Recording.2026-04-10.013913.mp4

Now notes visibility check box and Show Category/Gradeable Configuration state persists.
Also edited the cypress test for the same. Kindly give it a try and let me know if I need to refractor this further.

bmcutler · 2026-04-10T19:35:40Z

@jndlansh There are some lint errors, please correct them.
Thanks for your work on this and @GarvitKhandelwal31 and all the reviewers as well.
looking forward to installing this so my instructor colleagues can use this feature.

jndlansh · 2026-04-10T20:14:15Z

@jndlansh There are some lint errors, please correct them. Thanks for your work on this and @GarvitKhandelwal31 and all the reviewers as well. looking forward to installing this so my instructor colleagues can use this feature.

I have fixed the lint errors, thank you @bmcutler. Would love to work further together to improve the software.

Add show_notes UI control to Rainbow Grades configuration

e5c5870

github-project-automation Bot added this to Submitty Development Apr 7, 2026

github-project-automation Bot moved this to Seeking Reviewer in Submitty Development Apr 7, 2026

Eli-J-Schwartz approved these changes Apr 7, 2026

View reviewed changes

github-project-automation Bot moved this from Seeking Reviewer to Awaiting Maintainer Review in Submitty Development Apr 7, 2026

Eli-J-Schwartz mentioned this pull request Apr 7, 2026

[Feature:RainbowGrades] Add show_notes #12756

Closed

jndlansh added 2 commits April 8, 2026 00:25

Fix PHP lint

f09774b

Fix PHP lint

8346a9d

Add Customize notes visibilty - toggle

0976b58

Add cypress test for show notes dropdown

8895e87

GarvitKhandelwal31 reviewed Apr 9, 2026

View reviewed changes

Fix notes visibility check box state is not persisted + Cypress test

b1506ea

Fix Lint Errors

5411882

Merge branch 'main' into feature/rainbow-grades-show-notes

abc143f

bmcutler merged commit c52d47a into Submitty:main Apr 14, 2026
68 of 71 checks passed

Uh oh!

Conversation

jndlansh commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why is this Change Important & Necessary?

What is the New Behavior?

What steps should a reviewer take to reproduce or test?

Automated Testing & Documentation

Other information

Uh oh!

Eli-J-Schwartz left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Eli-J-Schwartz commented Apr 7, 2026

Uh oh!

codecov Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jndlansh commented Apr 7, 2026

Uh oh!

JManion32 commented Apr 7, 2026

Uh oh!

bmcutler commented Apr 8, 2026

Uh oh!

jndlansh commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GarvitKhandelwal31 commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jndlansh commented Apr 8, 2026

Uh oh!

GarvitKhandelwal31 commented Apr 9, 2026

Uh oh!

GarvitKhandelwal31 Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

jndlansh commented Apr 9, 2026

Uh oh!

bmcutler commented Apr 10, 2026

Uh oh!

jndlansh commented Apr 10, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jndlansh commented Apr 7, 2026 •

edited

Loading

Eli-J-Schwartz left a comment •

edited

Loading

codecov Bot commented Apr 7, 2026 •

edited

Loading

jndlansh commented Apr 8, 2026 •

edited

Loading

GarvitKhandelwal31 commented Apr 8, 2026 •

edited

Loading