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.

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

karls-languages: describe Analyzer feedback in .meta/design.md #2678

Closed
sanderploegsma opened this issue Jan 30, 2024 · 0 comments · Fixed by #2722
Closed

karls-languages: describe Analyzer feedback in .meta/design.md #2678

sanderploegsma opened this issue Jan 30, 2024 · 0 comments · Fixed by #2722
Assignees
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:status/claimed Someone is working on this issue x:type/content Work on content (e.g. exercises, concepts)

Comments

@sanderploegsma
Copy link
Contributor

sanderploegsma commented Jan 30, 2024

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

@sanderploegsma sanderploegsma changed the title karls-languages karls-languages: describe Analyzer feedback in .meta/design.md Jan 30, 2024
@sanderploegsma sanderploegsma added x:action/improve Improve existing functionality/content x:knowledge/elementary Little Exercism knowledge required x:module/concept-exercise Work on Concept Exercises x:type/content Work on content (e.g. exercises, concepts) labels Jan 30, 2024
@sanderploegsma sanderploegsma added the x:size/small Small amount of work label Jan 30, 2024
@manumafe98 manumafe98 self-assigned this Feb 5, 2024
@manumafe98 manumafe98 added the x:status/claimed Someone is working on this issue label Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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:status/claimed Someone is working on this issue x:type/content Work on content (e.g. exercises, concepts)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants