Allow instructors to be included on scoreboards

[NicholasMy]

This allows instructors to choose to include themselves and CAs on assessment scoreboards if they want, on a per-scoreboard basis.

Description

Instructors can check the box to include instructors on scoreboards on the "scoreboard settings page." If this is checked, instructors and CAs will be included in the scoreboard.

Motivation and Context

Professors want to compete with their students. A very old version of Autolab included everybody by default. There was an update that removed instructors. Some instructors want to be included, while others don't. Now they can choose.

How Has This Been Tested?

I created a couple scoreboards, verified instructors aren't included by default, checked the checkbox, verified instructors are now included on the scoreboard, unchecked the checkbox, verified instructors disappeared from the scoreboard.

Types of changes

• New feature (non-breaking change which adds functionality)

Checklist:

• I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting
• My change requires a change to the documentation, which is located at Autolab Docs
• I have updated the documentation accordingly, included in this PR

[coderabbitai]

Walkthrough

Walkthrough

The recent updates aim to enhance the functionality of scoreboards by enabling the inclusion of instructors in the display based on a new setting. These changes span across the controller, view files, and database schema. A migration introduces a new boolean column to support this feature, while the user interface is updated to provide control over this setting. Additionally, improvements in the view files enhance usability and presentation.

Changes

File Path	Change Summary
app/controllers/scoreboards_controller.rb	Updated show method to include instructors if @scoreboard.include_instructors is true; scoreboard_params now permits :include_instructors.
app/views/scoreboards/_form.html.erb	Removed outdated paragraph; added checkbox for including instructors, help_text attribute, and adjusted formatting.
app/views/scoreboards/show.html.erb	Modified conditional logic using unless; corrected loop structure for table columns.
db/migrate/20240208143255_add_include_instructors_to_scoreboard.rb	Added migration for include_instructors boolean column in scoreboards table.
db/schema.rb	Added include_instructors boolean column with default value false to scoreboards table.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[evanyeyeye]

LGTM. Made a few design modifications.