Extract track-specific help instructions from `config/exercise_readme.go.tmpl`

[ErikSchierboom]

Each track needs a file that contains track-specific instructions on how to get help. The contents of this document are only presented to the student when using the CLI. This file lives at exercises/shared/.docs/help.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 help instructions from the config/exercise_readme.go.tmpl file to the exercises/shared/.docs/help.md file.

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

Tracking

https://github.com/exercism/v3-launch/issues/50

[hsadia538]

Can I get assigned here @ErikSchierboom

[ErikSchierboom]

Sure!

[hsadia538]

@ErikSchierboom the current config/exercise_readme.go.tmpl does not seem to have help instructions. Also, Should I create the directory excercises/shared/.docs as no such exists as of now?

[ErikSchierboom]

@hsadia538 Yes, and it should have two files: help.md and tests.md. See the documentation for guidance on what the contents of those files should be.

[lpil]

Thank you @hsadia538 !

[hsadia538]

@ErikSchierboom do we have a gitter channel or forum for gleam? also I was unable to find the exercise track for gleam, why is that so?

[ErikSchierboom]

@hsadia538 I don't know of a specific gitter channel. If you email me at erik @ exercism.org, I can give you access to the Exercism slack.

As for which the Gleam track is not on Exercism yet, that is because it is not done. https://github.com/exercism/gleam/issues/32 contains a list of the things that need to happen for it to become active. Are you interested in getting the Gleam track launched?

[hsadia538]

Yes, I am interested in doing so. I have dropped you an email as well.

I was asking about the gitter channel as I was unsure as to what should I add in help.md and tests.md @ErikSchierboom

[ErikSchierboom]

I was asking about the gitter channel as I was unsure as to what should I add in help.md and tests.md

• The tests.md file should contain a concise description on how to run the tests
• The help.md file should link to any track-specific resources that could be useful to the student when trying to fix errors

See https://github.com/exercism/csharp/blob/main/exercises/shared/.docs/tests.md and https://github.com/exercism/csharp/blob/main/exercises/shared/.docs/help.md for examples.

[hsadia538]

I was unable to find much on gleam and I haven't gotten a chance to work on it before hence the questions. Another query is on running the test? the above example says You can run the tests by opening a command prompt in the exercise's directory, and then running the [dotnet test command](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test) Alternatively, most IDE's have built-in support for running tests, including [Visual Studio](https://docs.microsoft.com/en-us/visualstudio/test/run-unit-tests-with-test-explorer), [Rider](https://www.jetbrains.com/help/rider/Unit_Testing_in_Solution.html) and [Visual Studio code](https://github.com/OmniSharp/omnisharp-vscode/wiki/How-to-run-and-debug-unit-tests). See the [tests page](https://exercism.org/docs/tracks/csharp/tests) for more information. Skipped tests Initially, only the first test will be enabled. This is to encourage you to solve the exercise one step at a time. Once you get the first test passing, remove the Skip property from the next test and work on getting that test passing.

Would something like the same apply to gleam? The track isn't up and running so I haven't gotten a chance to see and run tests.

[lpil]

Hey @hsadia538 ! I can help with any specific questions around Gleam.

For that one I think we could have something like this:

You can run the tests by opening the terminal in the exercise's directory, and then running gleam test.

The gleeunit test framework doesn't offer a way to skip tests at the moment so I think we would have to have them all enabled, at least for now.

Thank you again for your help here 💜

[hsadia538]

Alright, thanks a lot I will create a PR shortly on this.

[giacomocavalieri]

@lpil this seem to have been fixed by #83, so maybe we could close it? Or is there anything missing?

[lpil]

I think so! Thank you