Skip to content

Commit e0fa410

Browse files
authored
Link README files together (#2504)
1 parent 5f2248b commit e0fa410

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ the [instructions in the README].
88

99
[instructions in the README]: README.md#building
1010

11+
## Testing
12+
13+
We test the course material in several ways:
14+
15+
- `mdbook test`: This will test the code samples. Some code sampes are marked
16+
with `ignore` in the Markdown file because the Playground is missing some of
17+
the crates we use. For this we have
18+
- `cargo test`: This will build and test the Rust code found in our tooling, as
19+
well as the code samples which cannot be tested using the Playground.
20+
- `npm test`: This will test the functionality of the rendered web pages. See
21+
the [testing README](tests/README.md) for details.
22+
1123
## Formatting
1224

1325
Please ensure that your files are formatted consistently. We use a few tools for

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,11 @@ where `xx` is the ISO 639 language code (e.g. `da` for the Danish translation).
100100
> **Note** On Windows, you need to enable symlinks
101101
> (`git config --global core.symlinks true`) and Developer Mode.
102102
103+
## Contributing
104+
105+
We would like to receive your contributions. Please see
106+
[CONTRIBUTING.md](CONTRIBUTING.md) for details.
107+
103108
## Contact
104109

105110
For questions or comments, please contact

0 commit comments

Comments
 (0)