Skip to content

add the design.md for the calculator-conundrum #3045

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.

Sign up for GitHub

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

Closed
xinri wants to merge 1 commit into from
Closed

add the design.md for the calculator-conundrum #3045

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions exercises/practice/calculator-conundrum/.meta/design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Design

## Analyzer

This exercise could benefit from the following rules in the [analyzer]:

- `essential`: Verify that the solution is not wrapping all the code in a try catch statement
- `actionable`: If the solution uses an `if` statement, instruct the student to use the `switch case` statement instead.
- `informative`: If the solution does not use `HashMap`, instruct the student to use the operator as a key and a BiFunction implementing the calculation
Explain that it is more efficient for performance, and it removes the cyclomatic complexity
- `informative`: If the solution does not throw the exception for `Operation cannot be null` and `Operation cannot be empty` at the beginning, instruct the student to do so
Explain that it is better to fail fast, and it will make the code less error-prone and more readable

[analyzer]: https://github.com/exercism/java-analyzer