Skip to content
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.

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

Update 'Run tests' section in README files to avoid comfusion #63

Closed
ilya-khadykin opened this issue Aug 10, 2017 · 3 comments
Closed

Comments

@ilya-khadykin
Copy link
Contributor

There are some exercises which have auto-generated README file and require 'Run tests' section update

List of all affected exercises:

In correct version of README file exercise specific test Spec file should be mentioned (example)

@kytrinyx
Copy link
Member

@m-a-ge I am tweaking Configlet so that we can regenerate all the READMEs with the correct filename. See exercism/configlet#48

Once this is merged and a release is cut, we can update the readme template (https://github.com/exercism/groovy/blob/master/config/exercise_readme.go.tmpl) to directly include the text that is currently in the readme insert (https://github.com/exercism/groovy/blob/master/docs/EXERCISE_README_INSERT.md).

We will be able to generate the command to run the tests in the template:

$ groovy ./{{ .Spec.MixedCaseName }}Spec.groovy

So we can delete the readme insert, and put all of it directly into the template like this.

{{- with .TrackInsert }}
{{ . }}
{{ end }}

@ilya-khadykin
Copy link
Contributor Author

ilya-khadykin commented Aug 11, 2017

@kytrinyx, thanks a lot for the explanation. Looks like I've missed it.
I should read more about it

In the meantime, I'll close this issue since it isn't valid

@kytrinyx
Copy link
Member

There's detailed information here: https://github.com/exercism/docs/blob/master/language-tracks/exercises/anatomy/readmes.md If anything is confusing, please let me know so I can update it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants