exercism / java

Exercism exercises in Java.
https://exercism.org/tracks/java
MIT License
691 stars 671 forks source link

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

Open sanderploegsma opened 8 months ago

sanderploegsma commented 8 months ago

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

rkabhishek commented 6 months ago

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!

sanderploegsma commented 6 months ago

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.

rkabhishek commented 6 months ago

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 commented 6 months ago

Hi, @sanderploegsma could you assign this to me?

manumafe98 commented 6 months ago

assigned @rkabhishek