Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ import collaborativeCodeEditor from './assets/programming/collaborative-editing-
import collaborativeMetadataModal from './assets/programming/collaborative-editing-metadata-modal.png';
import collaborativeProblemStatement from './assets/programming/collaborative-editing-problem-statement.gif';
import collaborativeNewCommitAlert from './assets/programming/collaborative-editing-new-commit-alert.png';
import reviewAddButton from './assets/programming/review-add-button.png';
import reviewAddThreadWidget from './assets/programming/review-add-thread-widget.png';
import reviewConsistencyThreadWidget from './assets/programming/review-consistency-thread-widget.png';
import reviewThreadWidget from './assets/programming/review-thread-widget.png';

# Programming Exercise

Expand Down Expand Up @@ -581,6 +585,46 @@ When someone pushes a commit to a repository (e.g., via Git CLI, an IDE, or "Sub
</ul>
</Callout>

### Review Comments

During exercise creation, instructors and editors can use review comments to discuss specific lines directly in the online editor. Review comments are meant for coordinating exercise authors before releasing or updating an exercise. They are not student feedback and are only visible to users who can edit the exercise.

<TumLiveVideo
src="https://live.rbg.tum.de/w/artemisintro/73628"
title="Video tutorial for review comments in programming exercises on TUM-Live"
/>

To add a review comment, open the exercise with <img src={editInEditor} alt="Edit in Editor" style={{display: 'inline', verticalAlign: 'middle', height: '2rem'}} />, hover next to the relevant line, and use the comment action. If Artemis asks you to submit first, click <img src={submitButton} alt="Submit" style={{display: 'inline', verticalAlign: 'middle', height: '2rem'}} /> so the comment can be attached to the current saved version of the file or problem statement.

<Image src={reviewAddButton} alt="Review comment button next to an editor line" size={ImageSize.medium} caption="Add a review comment from the editor gutter" />

<Image src={reviewAddThreadWidget} alt="Draft widget for adding a review comment" size={ImageSize.medium} caption="Drafting a new review comment" />

Review comments can be attached to:

- Problem statement lines
- Template repository files
- Solution repository files
- Test repository files
- Auxiliary repository files

Each review comment starts a thread at the selected location. Other instructors and editors working on the same exercise see new comments, replies, edits, deletions, and resolved states in real time. Files with unresolved review comments are marked in the file tree. Reply to a thread to continue the discussion, and resolve it when the issue has been addressed. Resolved threads remain available, but they are collapsed so open discussions stay visible.

<Image src={reviewThreadWidget} alt="Review comment thread with replies and resolve action" size={ImageSize.medium} caption="Review comment thread in the online editor" />

**Consistency Check Comments:** Hyperion's consistency check can create review comments for potential mismatches between the problem statement and the exercise repositories. These AI-created threads are labelled as consistency issues and show their severity and category. If one issue affects multiple artifacts, the related locations are grouped, and you can jump between them from the review comment. The issue navigator in the editor toolbar lets you move through the current consistency findings.

<Image src={reviewConsistencyThreadWidget} alt="AI-created consistency issue review comment with severity and category labels" size={ImageSize.large} caption="Consistency check result shown as a review comment" />

Some consistency check comments may include a suggested inline fix. This suggested change is intended for simple, local corrections, such as aligning a name, signature, or small code fragment. Review the suggested change before applying it. For complex or ambiguous issues, Artemis may leave the suggested fix empty and only keep the explanatory review comment.

<Callout variant={CalloutVariant.info}>
<p>
Review comments stay attached to saved exercise content. If the referenced line changes later, Artemis may mark the
thread as outdated. Re-check the referenced location before resolving the thread or applying an AI-suggested fix.
</p>
</Callout>

### Testing Frameworks by Language

Write test cases in the Test repository using language-specific frameworks:
Expand Down
Loading