Skip to content

docs: add a testing guide - #4274

Closed
DeviousCardi wants to merge 1 commit into
hyperium:masterfrom
DeviousCardi:docs/testing-guide
Closed

DeviousCardi wants to merge 1 commit into
hyperium:masterfrom
DeviousCardi:docs/testing-guide

Conversation

@DeviousCardi

Copy link
Copy Markdown

This adds the testing guide that is still unchecked in #2586.

docs/TESTING.md documents:

  • running the suite with cargo test --features full
  • narrower feature sets for faster loops
  • filtering to a single test or module
  • the nightly benches, Miri, and FFI test commands from CI
  • formatting and Clippy checks
  • the CI matrix (stable/beta/nightly on Linux, macOS, and Windows)

docs/README.md now links to the new document.

I verified the main command locally: cargo test --features full passes, including the doc tests.

Relates to #2586. The other unchecked items (release process, design notes, pull-request workflow) are left for separate changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant