logs-logs-logs: describe Analyzer feedback in .meta/design.md
#2681
Labels
x:action/improve
Improve existing functionality/content
x:knowledge/elementary
Little Exercism knowledge required
x:module/concept-exercise
Work on Concept Exercises
x:size/small
Small amount of work
x:type/content
Work on content (e.g. exercises, concepts)
Milestone
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
orcelebratory
, 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
The text was updated successfully, but these errors were encountered: