-
-
Notifications
You must be signed in to change notification settings - Fork 710
remote-control-competition: describe Analyzer feedback in .meta/design.md
#2683
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
Comments
.meta/design.md
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? |
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 exercism/java-analyzer#110. For this a bit more knowledge is required as you can see by the labels associated to that issue. |
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. |
Hi, @sanderploegsma could you assign this to me? |
assigned @rkabhishek |
Hey @rkabhishek, just wanted to ask if you're still working on this? |
Hi @kahgoh, I completely missed this one. Sorry. Can I work on it this week? |
Yeah, no probs! Thanks for replying! |
Uh oh!
There was an error while loading. Please reload this page.
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
orcelebratory
, 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
The text was updated successfully, but these errors were encountered: