Skip to content

Commit

Permalink
Link README files together (#2504)
Browse files Browse the repository at this point in the history
  • Loading branch information
mgeisler authored Dec 6, 2024
1 parent 5f2248b commit e0fa410
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e0fa410

Please sign in to comment.