exercism / exercism/java

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

Open
#2,681 2 comments 0 reactions 1 assignee Claimed by @habbie321 View on GitHub
x:action/improve x:knowledge/elementary x:module/concept-exercise x:size/small x:status/claimed x:type/content
Dominant language
Java
Stars
834
Forks
779
Avg merge
1d 1h
Merged PRs (30d)
3

Description

The `.meta/design.md` file of each concept exercise should contain a section describing what feedback the [analyzer](https://github.com/exercism/java-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](https://exercism.org/docs/building/tooling/analyzers/interface#h-type-optional)).

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.