exercism / meta

Experimenting with a repo to manage the project-wide, meta todos.
7 stars 2 forks source link

Submit issue to all tracks about having correct test command in each exercise README #92

Closed kytrinyx closed 6 years ago

kytrinyx commented 7 years ago

Problem

Several tracks put a generic instruction in the exercise README that says something like:

Run the following command:

$ test hello-world/HelloWorld.ext

Where 'hello-world' (or something else) is hard-coded, and then the README explains to swap that out with the actual name of the exercise and file.

Solution

Our README generator is now smart enough to be able to generate the proper file name so that each README has the correct instructions.

Groovy did it here: https://github.com/exercism/groovy/blob/master/config/exercise_readme.go.tmpl#L13

We have .Spec.MixedCaseName and will need to add .Spec.SnakeCaseName for languages that use that convention. We already have the .Spec.Slug for languages that use kebab-case.

TODO

Submit issues

Submit an issue to all exercism tracks that explains

Note that some tracks have fixed this, and other tracks have a single command that works for all the exercises, so it's not relevant.

Instead of figuring out which tracks this is relevant for, I make the issue text say something like "If this isn't relevant to this track, go ahead and close this issue".

You might be able to use blazon: https://github.com/exercism/blazon

Otherwise:

Fix documentation

We will also need to update the documentation, to mention these variables: https://github.com/exercism/docs/blob/master/language-tracks/exercises/anatomy/readmes.md

kytrinyx commented 6 years ago

Moved to https://github.com/exercism/exercism/issues/4393