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

Update design.md of each concept exercise to include analyzer comments #2668

Closed
sanderploegsma opened this issue Jan 30, 2024 · 1 comment
Closed

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 this section for a specific concept exercise, make sure to keep the following guidelines in mind: https://exercism.org/docs/building/tooling/analyzers/comments

@sanderploegsma
Copy link
Contributor Author

Split up into separate issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant