8000 add notes on how test runner works · spencer333/coderoad-vscode@c5a86b4 · GitHub
[go: up one dir, main page]
Skip to content

Commit c5a86b4

Browse files
ShMcKShMcK
committed
add notes on how test runner works
Signed-off-by: shmck <shawn.j.mckay@gmail.com>
1 parent 02d598d commit c5a86b4

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

‎docs/docs/how-it-works.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
id: how-coderoad-works
3+
title: How CodeRoad Works
4+
sidebar_label: How CodeRoad Works
5+
---
6+
7+
### Running Tests
8+
9+
In CodeRoad, the user is given a set of directions for a **task**.
10+
11+
Each task is judged to pass (✔) or fail (✘) by the result of code tests that runs in the background. Tests can be triggered by saving a file, or by a trigger that listens to specific files for changes.
12+
13+
![Test Flow Diagram](../images/test-flow-diagram.png)
14+
15+
If a test fails, the first failing test name is returned to the user as a hint to identify the problem.
16+
17+
Tests might be in another directory. Those folders or files might even be hidden from you by the tutorial creator.
18+
19+
But where does the code for these tests come from?

‎docs/images/test-flow-diagram.png

16.4 KB
Loading
< 30DC div class="d-flex flex-items-center flex-justify-between">

0 commit comments

Comments
 (0)
0