-
-
Notifications
You must be signed in to change notification settings - Fork 710
jedliks-toy-car: describe Analyzer feedback in .meta/design.md
#2676
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
AnalyzerThis section outlines how the analyzer should review submissions for the The feedback should be targeted, respectful, and encouraging, helping learners better understand vector math, coordinate manipulation, and algorithmic design in the context of satellite data interpretation. 1. ✅ Code Structure and ClarityWhat to check: Ensure that the solution follows clean coding practices—such as using descriptive variable and function names, breaking logic into reusable components, and avoiding code duplication. Why: Clear structure improves readability and maintainability, which are crucial in real-world software engineering. Feedback type:
Example comment: 2. 🛰️ Correctness of Coordinate ProcessingWhat to check: Validate whether the student is correctly applying vector math, triangulation logic, or geometry operations to determine the final position based on satellite data. Why: The core learning goal is to understand how to process and triangulate satellite coordinates accurately. Feedback type:
Example comment: 3. 🧮 Use of Mathematical AbstractionsWhat to check: Encourage the use of vector operations (like dot product, cross product, distance formulas) instead of manually coded logic that’s harder to generalize. Why: Reinforces abstraction and the use of standard mathematical tools rather than reinventing them manually. Feedback type:
Example comment: 4. 🧠 Algorithmic EfficiencyWhat to check: Examine if the solution unnecessarily loops through the same data or recalculates results multiple times. Why: Promotes optimization and efficient problem-solving—a key concept in all technical interviews and real applications. Feedback type:
Example comment: 5. 💥 Edge Case HandlingWhat to check: Review how the code responds to missing, malformed, or incomplete satellite data. Why: Teaches students the importance of robustness and resilience in their code. Feedback type:
Example comment: 6. 🎉 Positive ReinforcementWhat to check: If a submission is clean, correct, and well-structured, acknowledge the quality. Why: Encouragement boosts confidence and helps learners recognize good habits. Feedback type:
Example comment: 📌 Notes
|
@bishabadkri did you mean to comment in a different place? This issue is for the Elon's toy car exercise (since renamed to Jedik's toy car) on the Java track, not the Satellite exercise |
.meta/design.md
.meta/design.md
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: