Skip to content

Update information about adding unit tests #2806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jyn514 merged 2 commits into from
Mar 26, 2026
Merged

Update information about adding unit tests #2806

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b81c63
Update information about adding unit tests
Nokel81 Mar 26, 2026
cc1685c
Tweak wording of adding new tests guide
Nokel81 Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/tests/adding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@ guidelines:
- The majority of standard library tests are written as doctests, which
illustrate and exercise typical API behavior.
- Additional [unit tests](intro.md#package-tests) should go in
`library/${crate}/tests` (where `${crate}` is usually `core`, `alloc`, or
`std`).
`library/${crate}/tests` (where `${crate}` is usually `std`).
- Tests for the `alloc` or `core` crates must go within their respective
`library/${crate}tests/tests` folder.
Comment thread
Nokel81 marked this conversation as resolved.
Outdated
- NOTE: That when adding unit tests for unstable features the `#![feature(...)]`
declaration **must** be added to `library/${crate}tests/tests/lib.rs` and not to
Comment thread
Nokel81 marked this conversation as resolved.
Outdated
`library/${crate}tests/lib.rs`.
- If the code is part of an isolated system, and you are not testing compiler
output, consider using a [unit or integration test](intro.md#package-tests).
- Need to run rustdoc? Prefer a `rustdoc` or `rustdoc-ui` test. Occasionally
Expand Down
Loading