Inline the exercise README insert#197
Merged
petemcfarlane merged 4 commits intomasterfrom Feb 5, 2018
Merged
Conversation
added 4 commits
February 5, 2018 13:48
This updates all the exercise README files to match the latest problem descriptions.
This tweaks the instructions a bit, first to clarify that the instructions are relative to the PHP exercism workspace locally, and second to generate a phpunit command that uses the actual path to the exercise test file rather than always using Wordy as an example.
29a9079 to
3385c9e
Compare
This file contains hidden or 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
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.
Note: this is failing due to the PHP version conflict on Travis; PR to fix this is in #196 We should land that PR, and then rebase this onto the most recent master before proceeding with this change.
Currently, in the exercise README, we provide instructions on how to run the tests as follows:
In other words, we hard-code
wordyrather than using the actual path to the exercise in question.Since the README template can include dynamic data, this inlines the README insert into the template rather than keeping it in a markdown doc.
Since this is a pretty big change, I've made it in several commits, which should hopefully make it easier to review.
Commit 564ce59:
The Bob exercise in problem-specifications has been updated to include a new rule. Since the test suite in this track doesn't include the rule, I copied the
description.mdfile into theexercises/bob/.metadirectory so that when we generate the exercise README we don't get a README that describes the new rule.Commit 0977a52:
Regenerate all the exercise READMEs so that they match the most recent problem description. As far as I can tell, all the changes are minor tweaks, like clarifications to wording in the description, or formatting changes.
I did this first so that we get a clean diff in the next steps.
Commit 62380e3:
Rewrite the exercise README insert within the template
This tweaks the instructions a bit, first to clarify that the instructions are relative to the PHP exercism workspace locally, and second to generate a phpunit command that uses the actual path to the exercise test file rather than always using Wordy as an example.
Commit 29a9079:
And finally, regenerate the exercises to use the new test instructions.
Ref: exercism/meta#94