rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-04-22 23:58:39 +02:00
Code Issues Releases Activity

Link README files together (#2504)

Browse Source
This commit is contained in:
Martin Geisler 2024-12-06 09:00:25 -05:00 committed by GitHub
parent 5f2248bb92
commit e0fa410f93
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -8,6 +8,18 @@ the [instructions in the README].
[instructions in the README]: README.md#building [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 ## Formatting
Please ensure that your files are formatted consistently. We use a few tools for Please ensure that your files are formatted consistently. We use a few tools for

5
README.md
View File

@ -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 > **Note** On Windows, you need to enable symlinks
> (`git config --global core.symlinks true`) and Developer Mode. > (`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 ## Contact
For questions or comments, please contact For questions or comments, please contact