Skip to content

Commit cc14f2d

Browse files
authored
Clarifications in the reviewing exercise
After grading the exercise for WT25/26.
1 parent ba4e11a commit cc14f2d

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

04_documentation/reviewing_exercise.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,16 @@ Let us get familiar with code review tools and practices.
44

55
Deadline: **December 17, 2025, 9:00**
66

7-
**Note:** This is the first time that we have this exercise. Feedback and suggestions is very welcome - [open an issue](https://github.com/Simulation-Software-Engineering/Lecture-Material/issues).
7+
**Note:** In this exercise, we use GenAI tools, which evolve rapidly. Feedback and suggestions are very welcome - [open an issue](https://github.com/Simulation-Software-Engineering/Lecture-Material/issues).
8+
9+
## Prerequisites
10+
11+
- Login to the [Responsible AI](https://rai.uni-stuttgart.de)
12+
- Get access to [GitHub Education](https://github.com/education/students). After verification, according to GitHub, it might take up to 72h for the features to be available. If for any reason you cannot or do not want sign up for it, you can try any other code reviewing tool you might have available (e.g., Copilot in VSCode). For the grading, we do not need to see the output of the tool, but only your comments on your experience with it.
813

914
## Overview
1015

11-
In this exercise, you will work responsibly with AI tools to write and review code.
16+
In this exercise, you will work responsibly with AI tools to write code, review it as it if was a colleague's code, and use more AI tools for an additional review.
1217
More specifically, you will:
1318

1419
1. use [Responsible AI](https://rai.uni-stuttgart.de) to write a simulation program,
@@ -19,8 +24,6 @@ More specifically, you will:
1924

2025
In the end, you will need to open an issue in the [exercise repository](https://github.com/Simulation-Software-Engineering/reviewing-exercise) with name `[username] Reviewing exercise submission`.
2126

22-
**Update, Dec 10:** GitHub copilot is available as part of GitHub Pro, which you can get access to as a student via [GitHub Education](https://github.com/education/students). After verification, according to GitHub, it might take up to 72h for the features to be available. If for any reason you cannot or do not want sign up for it, you can try any other code reviewing tool you might have available (e.g., Copilot in VSCode). For the grading, we do not need to see the output of the tool, but only your comments on your experience with it. If you have no access to AI reviewing tools, declare that and put more emphasis on the comparison with your challenge project.
23-
2427
## Generate code
2528

2629
Generating code can be very useful to kick-start a project or to fill rather clear code parts (such as basic tests or documentation).
@@ -33,14 +36,16 @@ You remain in control and responsible for your projects.
3336
Now that we have set some guidelines, let's see the strengths in action:
3437

3538
1. Login to the [Responsible AI](https://rai.uni-stuttgart.de) provided by the University of Stuttgart.
36-
- Due to a bug (as of December 2025), start by saying "Hi" before proceeding with actual prompts. Apparently, bots also have psychological needs. :)
39+
- If the first prompt does not work, start by saying "Hi" before proceeding with actual prompts. Apparently, bots also have psychological needs. :)
3740
2. In your own words, ask the tool to generate code for solving a heat equation, in a programming language you understand (e.g., Python).
3841
Ask it to take parameters from a configuration file and write results to an output file.
3942
Ask for some documentation, tests, or anything else you would like to see in such a code.
4043
3. Create a repository on GitHub (under your namespace) and initialize it with a `README.md` file.
4144
4. Add the files that RAI created to the repository, in a branch called `feature`. In your commit message, clearly disclose the tool. For example:
4245

4346
```text
47+
(... usual commit message ...)
48+
4449
I acknowledge the use of RAI (https://rai.uni-stuttgart.de/) to implement the entirety of this code.
4550
4651
Prompts:
@@ -50,7 +55,7 @@ Now that we have set some guidelines, let's see the strengths in action:
5055

5156
The more details you add, the better.
5257

53-
5. Open a merge request from the branch `feature` to the `main` branch.
58+
5. Open a merge request from the branch `feature` to the `main` branch. Make sure to give a good PR title and description, as if you were contributing this code, and focusing on what this PR adds; not only the AI generation.
5459

5560
## Review the code
5661

@@ -72,9 +77,9 @@ Start an issue in the [exercise repository](https://github.com/Simulation-Softwa
7277

7378
GitHub Copilot can automatically review a pull request. Add it as a reviewer and wait for it to submit a review.
7479

75-
Carefully go through the review. Apply comments you agree with, comment on the points you don't agree with.
80+
Carefully go through the review. Comment on the suggestions, apply suggestions you agree with, comment on the points you don't agree with.
7681

77-
Optional: Give [custom instructions to Copilot](https://docs.github.com/en/copilot/tutorials/customization-library/custom-instructions) (such as [code reviewer](https://docs.github.com/en/copilot/tutorials/customization-library/custom-instructions/code-reviewer)).
82+
Optional: Give [custom instructions to Copilot](https://docs.github.com/en/copilot/tutorials/customization-library/custom-instructions) (such as [code reviewer](https://docs.github.com/en/copilot/tutorials/customization-library/custom-instructions/code-reviewer)). You could directly ask Copilot (agent) to apply specific suggestions in the same branch or in separate PRs.
7883

7984
In the issue you just opened, edit the description and comment:
8085

0 commit comments

Comments
 (0)