Skip to content

Documentation: Readme - Add workload philosophy section. #569

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

Merged
kotp merged 2 commits into from
Apr 26, 2017
Merged

Documentation: Readme - Add workload philosophy section. #569

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8460f3a
Add workload philosophy section.
Insti Apr 25, 2017
3bd8bf9
Reword based on feedback from @hilary.
Insti Apr 25, 2017
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
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ for the default template for everything except `workload`.
`workload` generates the code for the body of a test, including the assertion
and any setup required. The base class provides a variety of assertion and
helper methods. Beyond that, you can implement any helper methods that you need
as private methods in your derived class.
as private methods in your derived class. See below for more information about [the intention of workload](#workload-philosophy)

Below this class, implement a small loop that will generate all the test cases by reading the
`canonical-data.json` file, and looping through the test cases.
Expand Down Expand Up @@ -218,6 +218,23 @@ class ProblemNameTest < Minitest::Test
end
end
```
### Workload philosophy.

Prioritize educational value over expert comprehension and make sure that
things are clear to people who may not be familiar with Minitest and even Ruby.

Provide the information the student needs to derive the code to pass the test
in a clear and consistent manner. Illustrate the purpose of the individual
elements of the assertion by using meaningful variable names.

Example output from the `workload` method:
```ruby
detector = Anagram.new('allergy')
anagrams = detector.match(["gallery", "ballerina", "regally", "clergy", "largely", "leading"])
expected = ["gallery", "largely", "regally"]
assert_equal expected, anagrams.sort
```


## Pull Requests

Expand Down