rust-fuzz / rust-fuzz/arbitrary
What to do with `debug_assert!`s inside this crate?
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 880
- Forks
- 93
- PR merge metrics
- No merged PRs in 30d
Description
thought: should we be including this? fuzzing is usually run with debug assertions on so the debug_assert doesn't get us much. I am comfortable with more thoroughly documenting the safety situation instead
Originally posted by @Manishearth in https://github.com/rust-fuzz/arbitrary/pull/151#discussion_r1227499394
Another option is adding a test_assert! macro that is guarded on cfg(test), so it only runs for this crate's tests.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the discussion from pull request #151 and inventory the crate's existing debug_assert! uses. Compare the tradeoffs of documenting the safety situation versus adding a test_assert! macro guarded by cfg(test). Done means the project has a decided approach and the affected assertions consistently follow it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- testing-qa
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100