docs: update contributing.md - #31
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthrough
ChangesFuzz testing documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 202-205: Update the fuzz crash reproduction commands in
CONTRIBUTING.md after the `cd fuzz` instruction to reference `artifacts/...`
rather than `fuzz/artifacts/...`; replace the `cmin` minimization example with
`tmin <target> <crash-file>` while preserving the surrounding command guidance.
- Around line 182-190: Update the “Setup” section to document that fuzzing
requires a nightly Rust toolchain and a C++11-capable native compiler. Add the
rustup nightly installation and default/override steps before running cargo
fuzz, while preserving the existing cargo-fuzz installation guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: d422f8c8-7717-430e-a054-e8033b3976ae
📒 Files selected for processing (1)
CONTRIBUTING.md
Contribution Checklist
Description
Add CONTRIBUTING.md section on running the fuzz targets locally
Related Issue
Closes #27
Type of Change
Checklist
cargo clippy --all-targets -- -D warningspasses with no warningscargo fmt --checkpasses with no formatting issuescargo test --all-targetspassescargo test --docpassesunsafecode (or it is properly justified and documented)Additional Notes
Summary by CodeRabbit