Skip to content

Inline the exercise README insert#197

Merged
petemcfarlane merged 4 commits intomasterfrom
kytrinyx/inline-insert
Feb 5, 2018
Merged

Inline the exercise README insert#197
petemcfarlane merged 4 commits intomasterfrom
kytrinyx/inline-insert

Conversation

@kytrinyx
Copy link
Copy Markdown
Member

@kytrinyx kytrinyx commented Feb 4, 2018

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:

% phpunit.phar wordy/wordy_test.php

In other words, we hard-code wordy rather 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.md file into the exercises/bob/.meta directory 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

@kytrinyx kytrinyx changed the title [WIP] Inline the exercise README insert Inline the exercise README insert Feb 4, 2018
Katrina Owen 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.
@petemcfarlane petemcfarlane force-pushed the kytrinyx/inline-insert branch from 29a9079 to 3385c9e Compare February 5, 2018 13:48
@petemcfarlane petemcfarlane merged commit 46e4255 into master Feb 5, 2018
@petemcfarlane petemcfarlane deleted the kytrinyx/inline-insert branch February 5, 2018 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants