Skip to content

Commit 60eb604

Browse files
Add test track doc (#549)
1 parent 3246766 commit 60eb604

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed

building/config.json

+6
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,12 @@
230230
"path": "building/tracks/new/prepare-for-launch.md",
231231
"title": "Prepare for launch"
232232
},
233+
{
234+
"uuid": "3d4a4f07-7229-4910-9ba5-b7d931ff9177",
235+
"slug": "tracks/new/test-track",
236+
"path": "building/tracks/new/test-track.md",
237+
"title": "Test track"
238+
},
233239
{
234240
"uuid": "296dbe06-3384-409b-b2de-be52593c76d3",
235241
"slug": "tracks/new/find-maintainers",

building/tracks/new/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Once you've completed that step, the next steps are:
1515
- [Build test runner](/docs/building/tracks/new/build-test-runner)
1616
- [Configure tooling](/docs/building/tracks/new/configure-tooling)
1717
- [Prepare for launch](/docs/building/tracks/new/prepare-for-launch)
18+
- [Test track](/docs/building/tracks/new/test-track)
1819
- [Find Maintainers](/docs/building/tracks/new/find-maintainers)
1920
- [Launch!](/docs/building/tracks/new/launch)
2021
- [Enable syntax highlighting](/docs/building/tracks/new/syntax-highlighting)

building/tracks/new/test-track.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Test track
2+
3+
_Before_ launching your track (meaning, the `"active"` key is still `false` in the track's `config.json`), it is important the track is tested.
4+
This will help find (common) errors and allows them to be fixed _before_ the track is launched, which means that students won't ever encounter them.
5+
6+
## How to enable the track for testing
7+
8+
To enable the track for testing, it needs to be added to our database, which is something only site admins can do.
9+
Please open a topic on the forum requesting this at: https://forum.exercism.org/c/exercism/building-exercism/125.
10+
11+
Note that adding the track to the database will _not_ launch the track, but it _will_ make it accessible on the website for maintainer users.
12+
13+
## How to find testers
14+
15+
The ideal users to test the track are other track maintainers, as they:
16+
17+
- Have experience building a track (and thus know what should have been built)
18+
- Are able to access track's that are not yet active
19+
20+
To get maintainers to test your track, open a topic on the forum requesting this at: https://forum.exercism.org/c/exercism/building-exercism/125.

0 commit comments

Comments
 (0)