From 1abac8d240e5306a02d9fafaae8a4282e0a8bd0d Mon Sep 17 00:00:00 2001 From: Erik Schierboom <erik_schierboom@hotmail.com> Date: Wed, 14 Jul 2021 14:55:24 +0200 Subject: [PATCH] Extract help and test information to shared docs (#691) * Extract help and test information to shared docs * Update exercises/shared/tests.md Co-authored-by: Jeremy Walker <jez.walker@gmail.com> Co-authored-by: Jeremy Walker <jez.walker@gmail.com> --- config/exercise_readme.go.tmpl | 22 ---------------------- exercises/shared/help.md | 3 +++ exercises/shared/tests.md | 10 ++++++++++ 3 files changed, 13 insertions(+), 22 deletions(-) delete mode 100644 config/exercise_readme.go.tmpl create mode 100644 exercises/shared/help.md create mode 100644 exercises/shared/tests.md diff --git a/config/exercise_readme.go.tmpl b/config/exercise_readme.go.tmpl deleted file mode 100644 index 823c99e8..00000000 --- a/config/exercise_readme.go.tmpl +++ /dev/null @@ -1,22 +0,0 @@ -# {{ .Spec.Name }} - -{{ .Spec.Description -}} -{{- with .Hints }} -{{ . }} -{{ end }} -The Scala exercises assume an SBT project scheme. The exercise solution source -should be placed within the exercise directory/src/main/scala. The exercise -unit tests can be found within the exercise directory/src/test/scala. - -To run the tests simply run the command `sbt test` in the exercise directory. - -Please see the [learning](https://exercism.io/tracks/scala/learning) and -[installation](https://exercism.io/tracks/scala/installation) pages if you need any help. - -{{ with .Spec.Credits }} -## Source - -{{ . }} -{{ end }} -## Submitting Incomplete Solutions -It's possible to submit an incomplete solution so you can see how others have completed the exercise. diff --git a/exercises/shared/help.md b/exercises/shared/help.md new file mode 100644 index 00000000..0ca2e38b --- /dev/null +++ b/exercises/shared/help.md @@ -0,0 +1,3 @@ +# Help + +Please see the [learning](https://exercism.io/tracks/scala/learning) and [installation](https://exercism.io/tracks/scala/installation) pages if you need any help. diff --git a/exercises/shared/tests.md b/exercises/shared/tests.md new file mode 100644 index 00000000..a6e1c6b0 --- /dev/null +++ b/exercises/shared/tests.md @@ -0,0 +1,10 @@ +# Tests + +To run the tests, run the command `sbt test` in the exercise's directory. +See the [tests page](https://exercism.io/tracks/scala/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 `pending` keyword from the beginning of the next test and work on getting that test passing.