You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Expand docs about adding hello-world to a new track (#388)
* Expand docs about adding hello-world to a new track
Most people implementing a new track are unfamiliar with all the
moving pieces of a track and Exercism's tooling.
This adds a bit more hand-holding so that new volunteers don't
need to trawl through the reference documents and draw their
own conclusions about how to proceed.
* Improve configlet workflow suggestion to work around bug
Co-authored-by: Erik Schierboom <[email protected]>
* Tweak wording to clarify intent
Co-authored-by: Erik Schierboom <[email protected]>
* Fix punctuation
Co-authored-by: Erik Schierboom <[email protected]>
* Fix formatting
Co-authored-by: Erik Schierboom <[email protected]>
Co-authored-by: Erik Schierboom <[email protected]>
bin/configlet sync --update --tests include --exercise hello-world
61
+
```
62
+
63
+
In addition to the generated files, you will to create a test suite, a stub solution that serves as the starting point for the student, and a sample solution that passes all the tests to verify it is possible to solve the exercise (CI will verify this).
64
+
65
+
In order to create these files, you need to make some decisions about filenames and file paths.
66
+
The rule of thumb is to use names that are idiomatic for the language, and where there are no strong preferences prefer shallower directory structures.
67
+
The sample solution will need to be identifiable by the CI script, so it's advisable to choose a generic basename that all exercises can use, e.g. `example`, `sample`, or `reference-solution`.
68
+
69
+
### Configuring the exercise
70
+
71
+
One you've decided on the filenames and paths, edit the `exercises/practice/hello-world/.meta/config.json` file to reflect those choices.
72
+
Also add your GitHub username to the `"authors"` array.
0 commit comments