-
-
Notifications
You must be signed in to change notification settings - Fork 780
calculator-conundrum: describe Analyzer feedback in .meta/design.md #2673
Copy link
Copy link
Closed
Labels
x:action/improveImprove existing functionality/contentImprove existing functionality/contentx:knowledge/elementaryLittle Exercism knowledge requiredLittle Exercism knowledge requiredx:module/concept-exerciseWork on Concept ExercisesWork on Concept Exercisesx:size/smallSmall amount of workSmall amount of workx:type/contentWork on content (e.g. exercises, concepts)Work on content (e.g. exercises, concepts)
Description
Activity
Metadata
Metadata
Assignees
Labels
x:action/improveImprove existing functionality/contentImprove existing functionality/contentx:knowledge/elementaryLittle Exercism knowledge requiredLittle Exercism knowledge requiredx:module/concept-exerciseWork on Concept ExercisesWork on Concept Exercisesx:size/smallSmall amount of workSmall amount of workx:type/contentWork on content (e.g. exercises, concepts)Work on content (e.g. exercises, concepts)
The
.meta/design.mdfile 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,informativeorcelebratory, 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