Repository navigation
Add @DisplayName to Test Methods in Practice Exercises聽#2971
Description
Activity
Hi @kahgoh & @jagdish-15
My name is Emmanuel and I'm relatively new to open source contributions. This looks like an excellent opportunity for me to improve my Java skills while contributing to Exercism, which has been incredibly helpful in my TypeScript learning journey.
I'd love to work on this issue and would appreciate being assigned to it. I understand the guidelines about:- Limiting to max 15 exercises per PR
- Checking the unsynced exercises list in issue 馃毃 configlet sync --test found unsynced tests聽#2959
- Matching test descriptions from canonical-data.json
- Not closing the issue via PR references
I'm planning to start with a smaller batch (maybe 5-10 exercises) for my first PR to get comfortable with the workflow, then continue with additional PRs as needed.
Could you please assign me to this issue? I'm excited to contribute and help improve the Java track's test documentation!
Thanks!Reacted by Jagdish PrajapatiThanks for taking this on @EmmanuelBerkowicz! I have just assigned this one to you.
Reacted by EmmanuelHey @kahgoh ,
I've not used IntelliJ CheckStyle before.
It looks like that is the reason my pull request is not going through (ref attached image).
I've restarted my IDE with the plugin installed, and it's not showing anything different.
Is there anything obvious I might have overlooked or can do to push this through?
Sorry I'm not familar with the IntelliJ plugin, but I wonder if you need to do something to run it. With Gradle, you should also be to run it with
./gradlew check.In terms of the error in the CI, this is specific error:
Error: eckstyle] [ERROR] /home/runner/work/java/java/exercises/practice/swift-scheduling/src/test/java/SwiftSchedulingTest.java:131: Line is longer than 120 characters (found 124). [LineLength]I've also added a few comments on the PR regarding this error!
- added a commit that references this issue
on Jul 22, 2025 Thanks guys!
I've committed the suggested change :)Reacted by Jagdish Prajapati@EmmanuelBerkowicz,
The PR is merged now! You can now start working on other exercises.Reacted by Emmanuelhey @jagdish-15 ,
Is this closed?20 remaining items
Yes, the issue is still active, and the list is up-to-date. You can raise a PR for any exercises not already checked off, unless there鈥檚 an existing PR for them (there aren鈥檛 any at the moment).
I鈥檒l assign this issue to you as well!Reacted by manjarekarsudipHello, I will be looking through the list as well and plan to drop a pr for this as well. I don't know if it needs to be assigned to me, but willing to take it.
- added a commit that references this issue
on Nov 18, 2025 - added a commit that references this issue
on Nov 23, 2025 @jagdish-15 Is it ok if i join in this issue task as well?
Reacted by Jagdish Prajapati- added a commit that references this issue
on Dec 11, 2025 - added a commit that references this issue
on Dec 11, 2025 Hello @jagdish-15, I'll push a PR for the remaining zipper exercice, since the others seem to be merged already.
Reacted by Jagdish PrajapatiThanks everyone for the contributions! The last PR completes everything, so we can close this issue.
馃摑 Issue Description
This issue aims to add
@DisplayName()annotations for every test method in the test files of all practice exercises in the Java track.馃敡 What You Need to Do
Skip unsynced exercises:
Before starting, make sure the exercise is not listed among the ones with unsynced tests in issue #2959.
Locate the test file:
exercises/practice/<exercise-name>/src/test.<ExerciseName>Test.java).Find the canonical source:
canonical-data.json.Match and annotate tests:
.jsonfile are listed in a specific order.canonical-data.json."description"and use it as a@DisplayName("")annotation above the corresponding method in the Java test file.Max 15 exercises per PR:
To avoid large PRs, limit the number of exercises being updated in each PR to a maximum of 15 exercises (less is ok too).
Do not close this issue via PRs:
Avoid referencing this issue in your PR with terms like
Fixes #XXXorResolves #XXX, since this would automatically close the issue.Avoid reimplemented exercises:
Make sure you are not copying descriptions from tests that have been reimplemented.
Need help?
If you have any questions, feel free to ask in the comments!
馃搵 Checklist of Practice Exercises
馃挕 Reference Example
To understand how to properly add
@DisplayNameannotations based oncanonical-data.json, you can refer to the test file in the Swift Scheduling exercise.It already includes correctly formatted
@DisplayNameentries matching the test case descriptions, making it a good template for how your test file should look after the changes.