From 051c15dce5c15d5665fa9e86937d134417f698a2 Mon Sep 17 00:00:00 2001 From: Erik Schierboom Date: Wed, 14 Jul 2021 14:43:03 +0200 Subject: [PATCH] Add shared help and tests doc --- config/exercise_readme.go.tmpl | 24 --------------------- exercises/shared/.docs/help.md | 7 ++++++ exercises/shared/.docs/{cli.md => tests.md} | 8 +++---- 3 files changed, 11 insertions(+), 28 deletions(-) delete mode 100644 config/exercise_readme.go.tmpl create mode 100644 exercises/shared/.docs/help.md rename exercises/shared/.docs/{cli.md => tests.md} (79%) diff --git a/config/exercise_readme.go.tmpl b/config/exercise_readme.go.tmpl deleted file mode 100644 index 01b5ee50fd..0000000000 --- a/config/exercise_readme.go.tmpl +++ /dev/null @@ -1,24 +0,0 @@ -# {{ .Spec.Name }} - -{{ .Spec.Description -}} -{{- with .Hints }} -{{ . }} -{{ end }} -## Running the tests - -To run the tests, run the command `dotnet test` from within the exercise directory. - -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. -Once none of the tests are skipped and they are all passing, you can submit your solution -using `exercism submit {{ .Spec.MixedCaseName }}.cs` - -## Further information - -For more detailed information about the C# track, including how to get help if -you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources). -{{ with .Spec.Credits }} -## Source - -{{ . }} -{{ end }} diff --git a/exercises/shared/.docs/help.md b/exercises/shared/.docs/help.md new file mode 100644 index 0000000000..f5be77b42e --- /dev/null +++ b/exercises/shared/.docs/help.md @@ -0,0 +1,7 @@ +# Help + +To get help if you're having trouble, you can use one of the following resources: + +- [Gitter](https://gitter.im/exercism/xcsharp) is Exercism C# track's Gitter room; go here to get support and ask questions related to the C# track. +- [/r/csharp](https://www.reddit.com/r/csharp) is the C# subreddit. +- [StackOverflow](http://stackoverflow.com/questions/tagged/c%23) can be used to search for your problem and see if it has been answered already. You can also ask and answer questions. diff --git a/exercises/shared/.docs/cli.md b/exercises/shared/.docs/tests.md similarity index 79% rename from exercises/shared/.docs/cli.md rename to exercises/shared/.docs/tests.md index ecfd8e1c6b..6479293b32 100644 --- a/exercises/shared/.docs/cli.md +++ b/exercises/shared/.docs/tests.md @@ -1,10 +1,10 @@ -# CLI +# Tests -You can run the tests by opening a command prompt in the exercise's directory, and then running the [`dotnet test` command][docs-dotnet-test]. Alternatively, most IDE's have built-in support for running tests, including [Visual Studio][docs-run-unit-tests-visual-studio], [Rider][docs-run-unit-tests-rider] and [Visual Studio code][docs-run-unit-tests-visual-studio-code]. +You can run the tests by opening a command prompt in the exercise's directory, and then running the [`dotnet test` command][docs-dotnet-test]. Alternatively, most IDE's have built-in support for running tests, including [Visual Studio][docs-run-unit-tests-visual-studio], [Rider][docs-run-unit-tests-rider] and [Visual Studio code][docs-run-unit-tests-visual-studio-code]. See the [tests page](https://exercism.io/tracks/csharp/tests) for more information. -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. +## Skipped tests -Once none of the tests are skipped and they are all passing, you can submit your solution by opening a command prompt in the exercise's directory and running the [`exercism submit` command][docs-exercism-cli]. +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. [docs-dotnet-test]: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test?tabs=netcore21 [docs-exercism-cli]: https://exercism.io/cli