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 #429

Closed
ErikSchierboom opened this issue Jul 14, 2021 · 3 comments · Fixed by #430
Closed

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

ErikSchierboom opened this issue Jul 14, 2021 · 3 comments · Fixed by #430

Comments

@ErikSchierboom
Copy link
Member

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.

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

Tracking

exercism/v3-launch#51

@verdammelt
Copy link
Member

@ErikSchierboom this is a duplicate of #428 right?

@ErikSchierboom
Copy link
Member Author

@verdammelt Nope, they're similar but different. This one is about the shared tests.md file, #428 is about the shared help.md file.

@verdammelt
Copy link
Member

oh! I didn't read it closely enough. Glad I asked.

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 a pull request may close this issue.

2 participants