Adaptive learning: Improve the terminology of competency relations

[ardakaraman0]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Client

• I added multiple screenshots/screencasts of my UI changes.

Motivation and Context

The relations between competencies are textual nouns that make it hard to understand it.
Closes #9677

Description

Replaced nouns by adjectives:
e.g. "Assumes" -> "is required for"

Steps for Testing

Prerequisites:

• 1 Instructor

1. Log in to Artemis
2. Navigate to Course Administration
3. Go to Competencies section
4. Click on help button if the panel wasn't initialized
5. Check the new competency relations explanations

Testserver States

Note

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

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 even for very large courses with more than 2000 students.
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Exam Mode Test

• Test 1
• Test 2

Performance Tests

• Test 1
• Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

• New Features
  • Updated terminology in the competency management system for improved clarity, changing "Assumes" to "Requires" in relation types and descriptions.

[coderabbitai]

Walkthrough

The pull request focuses on updating the terminology in the competency.json file for English localization. The changes replace the term "Assumes" with "Requires" in relation types and their explanations. This modification aims to clarify the relationship dynamics between competencies, emphasizing the necessity of mastering prerequisite competencies for progression.

Changes

File	Change Summary
src/main/webapp/i18n/en/competency.json	Updated relation type from "Assumes" to "Requires" and modified corresponding explanatory text to reflect a more precise understanding of competency dependencies

Assessment against linked issues

Objective	Addressed	Explanation
Improve terminology of competency relations [#9677]	✅
Replace "Assumes" with more descriptive terminology	✅

Possibly related PRs

• Adaptive learning: Remove relates relation type for competencies #8993: Modifications to the "Assumes" relation type in competency terminology

Suggested labels

documentation, small, ready to merge, maintainer-approved

Suggested reviewers

• N0W0RK
• JohannesWt
• pzdr7
• florian-glombik
• dmytropolityka
• MaximilianAnzinger

---

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>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/main/webapp/i18n/en/competency.json (1)

303-317: LGTM! Well-structured documentation with clear examples.

The documentation effectively explains the relationship types using relatable bike-riding examples. The structure is clear and the HTML formatting is properly maintained.

Consider standardizing the capitalization of relationship types in the examples. Currently, some use quotes (e.g., "MATCH") while others don't (e.g., REQUIRES).

-                    "relationParagraph2": "Competency A: Balancing on a stationary bike. Competency B: Standing on one leg (balancing without moving). Here, balancing on a stationary bike might \"MATCH\" with balancing on one leg because both involve the same fundamental skill of balance. If you can do one, you're very likely able to do the other, as the core competency (balance) is the same in both scenarios.",
+                    "relationParagraph2": "Competency A: Balancing on a stationary bike. Competency B: Standing on one leg (balancing without moving). Here, balancing on a stationary bike might MATCH with balancing on one leg because both involve the same fundamental skill of balance. If you can do one, you're very likely able to do the other, as the core competency (balance) is the same in both scenarios.",

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5449cc4 and 125668a.

📒 Files selected for processing (1)

• src/main/webapp/i18n/en/competency.json (3 hunks)

🔇 Additional comments (2)

src/main/webapp/i18n/en/competency.json (2)

164-164: LGTM! Consistent terminology change.

The change from "Assumes" to "Requires" makes the relationship type clearer and more explicit, improving user understanding.

Also applies to: 257-257

---

169-170: LGTM! Clear and accurate relationship explanations.

The updated explanations effectively communicate the prerequisite nature of the relationship while maintaining consistency with the new "Requires" terminology.

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[flbrgit]

Tested on TS2, very good explanation. In terms of spelling I'd only suggest "In general, ..." instead of "In general ...", although this opinion might change from reader to reader. The rest is good, spelling, grammar and language

[vinceclifford]

Tested on TS2, works as expected.

[sachmii]

Tested on TS3, works as expected.

[HawKhiem]

Tested on TS1. LGTM