Skip to content

Update README with Exercise Generators #478

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
Insti merged 2 commits into from
Nov 28, 2016
Merged

Update README with Exercise Generators #478

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5352ff3
Update README with Exercise Generators
bmulvihill Oct 22, 2016
06fd378
Update definitions
bmulvihill Nov 28, 2016
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,16 @@ then additional inputs/outputs should be submitted to the x-common repository.
Changes to the test suite (style, boilerplate, etc) will probably have to be made to
Copy link
Copy Markdown
Member

@kotp kotp Nov 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add "Track specific" before "Changes"?

Copy link
Copy Markdown
Contributor

@Insti Insti Nov 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'track specific' might be redundant since this is only talking about the xruby track anyway.

Copy link
Copy Markdown
Member

@kotp kotp Nov 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True enough. Was thinking this was the more general documentation.

`example.tt`.

### Exercise Generators

If you wish to create a new generator, or edit an existing one, the generators currently live in the lib directory and are named `$PROBLEM_cases.rb`. For example, the hamming generator is `lib/hamming_cases.rb`.

All generators currently adhere to a common public interface, and must define the following three methods:

- `test_name` - Returns the name of the test (i.e `test_one_equals_one`)
- `workload` - Returns the main syntax for the test. This will vary depending on the test generator and its underlying implementation
- `skipped` - Returns skip syntax (i.e. `skip` or `# skip`)

## Pull Requests

We welcome pull requests that provide fixes to existing test suites (missing
Expand Down