Skip to content

Commit c4f5971

Browse files
Move test generator note (#575)
1 parent c7a0397 commit c4f5971

File tree

3 files changed

+7
-27
lines changed

3 files changed

+7
-27
lines changed

building/configlet/create.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -22,32 +22,7 @@ Options for create:
2222

2323
## Create Practice Exercise
2424

25-
To create a practice exercise, one has to specify its slug:
26-
27-
```shell
28-
configlet create --practice-exercise collatz-conjecture
29-
```
30-
31-
This will create the practice exercise's required files, as specified in the [Practice Exercises docs](/docs/building/tracks/practice-exercises).
32-
If the practice exercise is defined in the [Problem Specifications repo](https://github.com/exercism/problem-specifications/), configlet will sync the docs and metadata from there.
33-
34-
Of course, this is just the first step towards creating an exercise.
35-
You'll then have to:
36-
37-
- Add tests to the tests file
38-
- Add an example implementation
39-
- Define the stub file's contents
40-
- Within the exercise's `.meta/config.json` file:
41-
- Add the GitHub username of the exercise's authors to the `authors` key
42-
- Within the track's `config.json` file:
43-
- Check/update the exercise's difficulty
44-
- Add concepts to the `practices` key (only required when the track has concept exercises)
45-
- Add concepts to the `prerequisites` key (only required when the track has concept exercises)
46-
47-
```exercism/note
48-
Some tracks have implemented an exercise/test _generator_, which is a tool that can generate the test file's contents based on the exercise's `canonical-data.json` found in the [Problem Specifications repo](https://github.com/exercism/problem-specifications/).
49-
Make sure to read the track's documentation to see if there is a generator that you can use.
50-
```
25+
The [Add Practice Exercise docs](/docs/building/tracks/practice-exercises/add) have detailed instructions on how to add a Practice Exercise.
5126

5227
## Create Concept Exercise
5328

building/tracks/new/add-initial-exercises.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ To make this all a bit more concrete, this is what a sample selection of initial
104104
## Implement exercises
105105

106106
Having selected the exercises you want include in your track, the next step is to implement them.
107-
The [Add Practice Exercise docs](/docs/building/tracks/practice-exercises/add) have detailed instructions on how to add a Practic Exercise.
107+
The [Add Practice Exercise docs](/docs/building/tracks/practice-exercises/add) have detailed instructions on how to add a Practice Exercise.
108108

109109
[problem-specifications-exercises]: https://github.com/exercism/problem-specifications/tree/main/exercises/
110110
[allergies]: https://github.com/exercism/problem-specifications/tree/main/exercises/allergies

building/tracks/practice-exercises/add.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,11 @@ Keep in mind, though, that you should tweak the implementation to best fit your
5555
As an example, some tracks do not use classes but only work with functions.
5656
If your track usually works with objects though, you should adapt the implementation to what best fits your track.
5757

58+
```exercism/note
59+
Some tracks use a [test _generator_](/docs/building/tooling/test-generators) to automatically (re-)generate an exercise's test file(s).
60+
Please check the track documentation to see if there is a test generator and if so, how to use it.
61+
```
62+
5863
### Add example implementation
5964

6065
To ensure that it is possible to write code that passes the tests, an example implementation needs to be added.

0 commit comments

Comments
 (0)