Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adaptive learning: Make exercise competencies management consistent #8064

Merged
merged 3 commits into from
Feb 28, 2024

Conversation

milljoniaer
Copy link
Contributor

@milljoniaer milljoniaer commented Feb 23, 2024

Checklist

General

Client

  • Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data.
  • I strictly followed the client coding and design guidelines.
  • Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
  • I added multiple screenshots/screencasts of my UI changes.

Motivation and Context

The competency selector for exercises has been located at a different position in the different exercise type edit views and the current selected competencies have not been shown on the exercise detail page.

Description

This PR moves the Competency Selector for all exercise types to the end of the problem statement section. Both in the edit view and the detail view.

Steps for Testing

Prerequisites:

  • 1 Instructor
  • 1 Course with competencies
  1. Log in to Artemis
  2. Navigate to Exercise Overview
  3. Check for all exercise types that the competency selector is placed below the problem statement in the edit mode
  4. Check for all exercise types that the selected competencies are shown on the detail page of the exercise

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked







Review Progress

Performance Review

  • I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Test Coverage

Client

Class/File Line Coverage Confirmation (assert/expect)
file-upload-exercise-detail.component.ts 97.91%
modeling-exercise-detail.component.ts 93.05%
programming-exercise-detail.component.ts 86.47%
quiz-exercise-detail.component.ts 95.65%
utils.ts 86.36%
text-exercise-detail.component.ts 100%

Screenshots

image
image

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced a competency selection section for exercises across various types (file upload, modeling, programming, quiz, and text) based on exam mode conditions.
    • Enhanced display of exercise details to include competencies when present, improving information accessibility for users.
  • Enhancements

    • Reorganized HTML structure for file upload and text exercise update components for better usability.
    • Modified exercise detail components to dynamically display competencies, enriching the exercise information provided to users.

@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Feb 23, 2024
@milljoniaer milljoniaer marked this pull request as ready for review February 23, 2024 14:59
@milljoniaer milljoniaer requested a review from a team as a code owner February 23, 2024 14:59
Copy link

coderabbitai bot commented Feb 23, 2024

Walkthrough

This update introduces competency-related enhancements across various exercise components in a web application. It includes adding competency selection sections and modifying existing functions to incorporate competencies more dynamically. The changes aim to improve the management and display of competencies in exercises, making the system more flexible and user-friendly.

Changes

Files Change Summary
.../file-upload/manage/file-upload-exercise-detail.component.ts Added fileUploadExercise as an argument in getExerciseProblemDetailSection function.
.../modeling/manage/modeling-exercise-detail.component.ts Included modelingExercise in getExerciseProblemDetailSection function call.
.../programming/manage/programming-exercise-detail.component.ts Dynamically populates details array with competencies in getExerciseDetailsProblemSection.
.../quiz/manage/quiz-exercise-detail.component.ts Logic added to display competencies in the mode details section.
.../text/manage/text-exercise/text-exercise-detail.component.ts Included textExercise in getExerciseProblemDetailSection call.
.../shared/utils.ts getExerciseProblemDetailSection function updated to accept exercise parameter.
.../file-upload/manage/file-upload-exercise-update.component.html Added competency selection section; reorganized HTML structure.
.../modeling/manage/modeling-exercise-update.component.html Conditional block for competency selection added, visible if not in exam mode.
.../text/manage/text-exercise/text-exercise-update.component.html Competency selection section added to the form; moved its position in the HTML file.

Related issues

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

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.

rstief
rstief previously approved these changes Feb 24, 2024
Copy link
Contributor

@rstief rstief left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code lgtm

Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested on TS2 - the linked competencies for programming exercises didn't show up for me.

Screenshots

grafik

grafik

Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested on TS2 for all exercise types.

  • Competencies are shown (if present) under the problem statement when editing
  • Same when viewing

-> Works as expected!

Copy link
Contributor

@basak-akan basak-akan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested on TS5 with all types of exercises, worked as described

Copy link

@AntonGeTUM AntonGeTUM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Manually tested, competencies/linked competencies are shown as described

Copy link
Contributor

@laurenzfb laurenzfb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code lgtm

@krusche krusche changed the title Adaptive Learning: Make exercise competencies management consistent Adaptive learning: Make exercise competencies management consistent Feb 28, 2024
@krusche krusche added this to the 6.9.0 milestone Feb 28, 2024
@krusche krusche merged commit ca025f7 into develop Feb 28, 2024
107 of 112 checks passed
@krusche krusche deleted the chore/make-exercise-competencies-consistent branch February 28, 2024 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants