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

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

Open
sanderploegsma opened this issue Jan 30, 2024 · 5 comments
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 remote-control-competition remote-control-competition: 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
@rkabhishek
Copy link
Contributor

rkabhishek commented Mar 26, 2024

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
Copy link
Contributor Author

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.

@rkabhishek
Copy link
Contributor

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
Copy link
Contributor

Hi, @sanderploegsma could you assign this to me?

@manumafe98 manumafe98 self-assigned this Apr 4, 2024
@manumafe98 manumafe98 added the x:status/claimed Someone is working on this issue label Apr 4, 2024
@manumafe98
Copy link
Contributor

assigned @rkabhishek

@manumafe98 manumafe98 assigned rkabhishek and unassigned manumafe98 Apr 4, 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

No branches or pull requests

3 participants