Added exercise structure to README #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As discussed in issue #2.
kytrinyx
requested changes
Nov 28, 2016
| `exercises/<name>/runtests.jl` Test suite for the exercise. Group related tests using [testsets](http://docs.julialang.org/en/release-0.5/stdlib/test/#working-with-test-sets). | ||
|
|
||
| `exercises/<name>/example.jl` Example solution for the exercise. It should follow the [Julia Style Guide](http://docs.julialang.org/en/release-0.5/manual/style-guide/). | ||
| <!-- See Issue 2 for discussion --> |
There was a problem hiding this comment.
Let's make this an actual link to the issue: #2
| `exercises/<name>/example.jl` Example solution for the exercise. It should follow the [Julia Style Guide](http://docs.julialang.org/en/release-0.5/manual/style-guide/). | ||
| <!-- See Issue 2 for discussion --> | ||
|
|
||
| (`<name>` refers to the exercise name) |
There was a problem hiding this comment.
We've been using the word slug for this elsewhere. It's the URL-friendly identifier for a given exercise. The name of the exercise is what would go in the title of the README for it. So:
- name: Hello World
- slug:
hello-world
We've actually struggled quite a lot with terminology, and thrashed around a lot so you'll probably see remnants of old names strewn around various codebases and issues and pull requests.
|
Applied your suggestions. Not quite sure if that's what you meant with the slug-comment. Let me know if it's not. |
kytrinyx
approved these changes
Nov 29, 2016
|
Yepp, this looks great! Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed in issue #2.
Closes #2