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: Translation is not found in editing competency relations #10201

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

ardakaraman0
Copy link
Contributor

@ardakaraman0 ardakaraman0 commented Jan 24, 2025

Checklist

General

Client

  • I added multiple screenshots/screencasts of my UI changes.
  • I translated all newly inserted strings into English and German.

Motivation and Context

Closes #10200

Description

I have reverted the use of REQUIRES var name back to ASSUMES, since we still use the same terminology in the codebase.

Steps for Testing

Prerequisites:

  • 1 Instructor
  • 1 Course with competencies
  1. Log in to Artemis
  2. Navigate to Course Management
  3. Click on "Competencies" tab
  4. Click on "Edit Relations"
  5. Click on "Relation Type" dropdown menu
  6. See the first item is "Requires"

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

Screenshot 2025-01-24 at 18 38 16

Summary by CodeRabbit

  • Documentation
    • Updated terminology for competency relations from "REQUIRES" to "ASSUMES"
    • Maintained the existing explanation for competency relationship
    • Refined semantic description of competency dependencies

@ardakaraman0 ardakaraman0 self-assigned this Jan 24, 2025
@ardakaraman0 ardakaraman0 requested a review from a team as a code owner January 24, 2025 19:16
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Jan 24, 2025
Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

The pull request involves updating the terminology in the English language JSON file for competencies. Specifically, the relation type "REQUIRES" has been renamed to "ASSUMES" in the src/main/webapp/i18n/en/competency.json file. This change affects the semantic representation of competency relationships, modifying how the relationship between competencies is described while maintaining the underlying logical meaning.

Changes

File Change Summary
src/main/webapp/i18n/en/competency.json - Renamed relation type from "REQUIRES" to "ASSUMES"
- Updated corresponding type explanation to use "ASSUMES"

Possibly related PRs

Suggested labels

client, documentation

Suggested reviewers

  • ufukygmr
  • MaximilianAnzinger
  • krusche
  • HawKhiem

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4bc01b6 and ca2d53b.

📒 Files selected for processing (1)
  • src/main/webapp/i18n/en/competency.json (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: client-style
  • GitHub Check: server-tests
  • GitHub Check: server-style
  • GitHub Check: client-tests
  • GitHub Check: Build and Push Docker Image
  • GitHub Check: Build .war artifact
  • GitHub Check: Analyse
🔇 Additional comments (3)
src/main/webapp/i18n/en/competency.json (3)

169-171: LGTM! Explanation text remains accurate.

The explanation text correctly describes a prerequisite relationship and remains unchanged, maintaining semantic clarity while updating the internal terminology.


257-259: LGTM! Terminology is consistent across sections.

The change maintains consistency between the competency and courseCompetency sections, ensuring a uniform terminology throughout the file.


164-166: LGTM! Terminology change maintains UI consistency.

The change from "REQUIRES" to "ASSUMES" as the internal key while keeping "Requires" as the display text aligns with the PR objectives and maintains UI consistency.

Let's verify that this is the only occurrence of "REQUIRES" in the codebase:

✅ Verification successful

Terminology change is complete and consistent

The codebase scan confirms that all instances of "REQUIRES" as a key have been successfully changed to "ASSUMES", while properly maintaining "Requires" as the display text where appropriate. The only remaining occurrences are in package-lock.json files which are unrelated npm configurations.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining instances of "REQUIRES" that might need updating
rg '"REQUIRES"' --type json

Length of output: 29


Script:

#!/bin/bash
# Search for "REQUIRES" in all files, case-insensitive
echo "=== Searching for REQUIRES in all files ==="
rg -i '"REQUIRES"'

echo -e "\n=== Searching specifically in i18n directories ==="
fd -t f . -p '**/i18n/**' -x rg -i '"REQUIRES"' {}

Length of output: 1001


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>, 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.

Copy link

@HawKhiem HawKhiem left a comment

Choose a reason for hiding this comment

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

Tested pm TS1. Works as described

image

Copy link

@Cathy0123456789 Cathy0123456789 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 TS1. Works as expected
image

Copy link

@ItsaaaMeMario ItsaaaMeMario 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, works as expected.
grafik

Copy link
Contributor

@asliayk asliayk 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, works as expected

Copy link
Contributor

@tobias-lippert tobias-lippert 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

@zagemello zagemello 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, all works as expected

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix client Pull requests that update TypeScript code. (Added Automatically!) component:AdaptiveLearning ready for review small
Projects
Status: Work In Progress
Development

Successfully merging this pull request may close these issues.

Translation is not found in editing competency relations
7 participants