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

Extract track-specific test instructions from config/exercise_readme.go.tmpl #51

Open
ErikSchierboom opened this issue Jul 14, 2021 · 4 comments

Comments

@ErikSchierboom
Copy link
Member

ErikSchierboom commented Jul 14, 2021

Each track needs a file that contains track-specific instructions on how to manually run the tests. The contents of this document are only presented to the student when using the CLI. This file lives at exercises/shared/.docs/tests.md. You almost certainly already have this information, but need to move it to the correct place.

For v2 tracks, this information was (usually) included in the readme template found at config/exercise_readme.go.tmpl. As such, tracks can extract the test instructions from the config/exercise_readme.go.tmpl file to the exercises/shared/.docs/tests.md file.

https://github.com/exercism/csharp/pull/1557/files for an example PR.

@ErikSchierboom ErikSchierboom changed the title Add track-specific test instructions Extract track-specific test instructions from config/exercise_readme.go.tmpl Jul 14, 2021
This was referenced Jul 14, 2021
@glennj
Copy link

glennj commented Jul 14, 2021

Should other information in the exercise_readme.go.tmpl file also be moved into different lines under ./exercises/shared/.docs?

@ErikSchierboom
Copy link
Member Author

@glennj What other information do you have?

@glennj
Copy link

glennj commented Jul 14, 2021

I just found the https://github.com/exercism/docs/blob/main/building/tracks/presentation.md document which is helpful.

My tracks are also missing the exercises/shared/.docs/help.md file

The exercise_readme.go.tmpl for bash has a section about using external tools versus the "extra credit" of solving the problem with plain bash. It seems that the help.md is the place to put that.

@ErikSchierboom
Copy link
Member Author

Yeah I think that makes sense.

@ErikSchierboom ErikSchierboom added x:action/improve Improve existing functionality/content x:size/massive Massive amount of work x:type/coding Write code that is not student-facing content (e.g. test-runners, generators, but not exercises) x:knowledge/none No existing Exercism knowledge required x:size/large Large amount of work x:knowledge/intermediate Quite a bit of Exercism knowledge required x:module/practice-exercise Work on Practice Exercises x:size/small Small amount of work x:size/tiny Tiny amount of work x:type/content Work on content (e.g. exercises, concepts) x:module/test-runner Work on Test Runners x:action/create Work on something from scratch x:knowledge/advanced Comprehensive Exercism knowledge required and removed x:action/improve Improve existing functionality/content x:size/massive Massive amount of work x:type/coding Write code that is not student-facing content (e.g. test-runners, generators, but not exercises) x:knowledge/none No existing Exercism knowledge required x:size/large Large amount of work x:knowledge/intermediate Quite a bit of Exercism knowledge required x:module/practice-exercise Work on Practice Exercises x:size/small Small amount of work x:size/tiny Tiny amount of work x:type/content Work on content (e.g. exercises, concepts) x:module/test-runner Work on Test Runners x:action/create Work on something from scratch x:knowledge/advanced Comprehensive Exercism knowledge required labels Aug 18, 2021
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

No branches or pull requests

2 participants