java icon indicating copy to clipboard operation
java copied to clipboard

remote-control-competition: describe Analyzer feedback in `.meta/design.md`

Open sanderploegsma opened this issue 1 year ago • 5 comments

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 avatar Jan 30 '24 18:01 sanderploegsma

Hi, what's the prerequisite to take this up? I know this is marked as small and needing elementary knowledge of exercism, but how much knowledge of the analyzer is needed to work on this? Would it be a good idea to set up the analyzer locally and run it before doing this? Thanks!

rkabhishek avatar Mar 26 '24 12:03 rkabhishek

Hi @rkabhishek, this specific issue only covers the design part of the analyzer, so documenting what type of feedback should be given by the analyzer and in what cases. Therefore it doesn't require a lot of knowledge of Exercism or the analyzer itself, other than the resources I linked in the description.

If you're interested in coding the analyzer itself, this is covered in https://github.com/exercism/java-analyzer/issues/110. For this a bit more knowledge is required as you can see by the labels associated to that issue.

sanderploegsma avatar Mar 30 '24 20:03 sanderploegsma

Thanks for clarifying it @sanderploegsma. I will pick this up first, and then later I can pick up the analyzer too after having some more experience.

rkabhishek avatar Mar 31 '24 12:03 rkabhishek

Hi, @sanderploegsma could you assign this to me?

rkabhishek avatar Apr 04 '24 11:04 rkabhishek

assigned @rkabhishek

manumafe98 avatar Apr 04 '24 13:04 manumafe98