diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f3842bd897a..9fb9974b77c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,18 @@ the [instructions in the README]. [instructions in the README]: README.md#building +## Testing + +We test the course material in several ways: + +- `mdbook test`: This will test the code samples. Some code sampes are marked + with `ignore` in the Markdown file because the Playground is missing some of + the crates we use. For this we have +- `cargo test`: This will build and test the Rust code found in our tooling, as + well as the code samples which cannot be tested using the Playground. +- `npm test`: This will test the functionality of the rendered web pages. See + the [testing README](tests/README.md) for details. + ## Formatting Please ensure that your files are formatted consistently. We use a few tools for diff --git a/README.md b/README.md index aaaa75ccc66..89cfd563b23 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,11 @@ where `xx` is the ISO 639 language code (e.g. `da` for the Danish translation). > **Note** On Windows, you need to enable symlinks > (`git config --global core.symlinks true`) and Developer Mode. +## Contributing + +We would like to receive your contributions. Please see +[CONTRIBUTING.md](CONTRIBUTING.md) for details. + ## Contact For questions or comments, please contact