exercism / java

Exercism exercises in Java.
https://exercism.org/tracks/java
MIT License
688 stars 672 forks source link

logs-logs-logs: describe Analyzer feedback in `.meta/design.md` #2681

Open sanderploegsma opened 7 months ago

sanderploegsma commented 7 months ago

The .meta/design.md file of each concept exercise should contain a section describing what feedback the analyzer should provide and when. This is a prerequisite for implementing the analyzer for each of these exercises.

The section should clearly describe what should be checked by the analyzer, what feedback should be given to the student and the type of each comment (essential, actionable, informative or celebratory, see the documentation).

Here is a good example of what it might look like: https://github.com/exercism/javascript/blob/main/exercises/concept/mixed-juices/.meta/design.md

When writing the analyzer section for this concept exercise, make sure to keep the following guidelines in mind: https://exercism.org/docs/building/tooling/analyzers/comments

GIRONREYES commented 1 month ago

.