-
-
Notifications
You must be signed in to change notification settings - Fork 3
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
Comments
config/exercise_readme.go.tmpl
config/exercise_readme.go.tmpl
exercism/emacs-lisp#186
Should other information in the exercise_readme.go.tmpl file also be moved into different lines under ./exercises/shared/.docs? |
@glennj What other information do you have? |
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. |
Yeah I think that makes sense. |
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 theconfig/exercise_readme.go.tmpl
file to theexercises/shared/.docs/tests.md
file.https://github.com/exercism/csharp/pull/1557/files for an example PR.
The text was updated successfully, but these errors were encountered: