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.

Sign up for GitHub

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

Adding analyzer feedback to design.md for log levels concept exercise #2694

Merged
merged 5 commits into from
Jan 31, 2024
Merged

Adding analyzer feedback to design.md for log levels concept exercise #2694

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0288b54
Adding analyzer feedback to design.md for log levels concept exercise
manumafe98 Jan 31, 2024
5cddff6
Updating analyzer information
manumafe98 Jan 31, 2024
30a6812
Adding essential analyzer topic
manumafe98 Jan 31, 2024
dd22459
Applying suggestion on string.format
manumafe98 Jan 31, 2024
403dc24
Update exercises/concept/log-levels/.meta/design.md
manumafe98 Jan 31, 2024
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
14 changes: 14 additions & 0 deletions exercises/concept/log-levels/.meta/design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,17 @@
This exercise's prerequisites Concepts are:

- `basics`: know how to define methods.

## Analyzer

This exercise could benefit from the following rules in the [analyzer]:

- `essential`: Verify that the solution does not hard-code the log levels (`[ERROR]:`, `[WARNING]:`, `[INFO]:`)
- `actionable`: If the student did not reuse the implementation of the `message` and `logLevel` methods in the `reformat` method, instruct them to do so.
- `actionable`: If the solution did not use `substring` in the methods `message` and `logLevel`, instruct the student to do so.
- `informative`: If the solution uses `String.format` in the `reformat` method, inform the student that this cause a small performance penalty compared to string concatenation.

If the solution does not receive any of the above feedback, it must be exemplar.
Leave a `celebratory` comment to celebrate the success!

[analyzer]: https://github.com/exercism/java-analyzer