Skip to content

docs: update contributing.md - #31

Merged
AteebNoOne merged 2 commits into
iTeebot:mainfrom
anidroid1184:doc/add-new-contributing-section
Jul 21, 2026
Merged

docs: update contributing.md#31
AteebNoOne merged 2 commits into
iTeebot:mainfrom
anidroid1184:doc/add-new-contributing-section

Conversation

@anidroid1184

@anidroid1184 anidroid1184 commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Contribution Checklist

  • ⭐ I have starred the repository
  • 🔀 I have forked the repository and created a new branch for my changes
  • 📖 I have read the CONTRIBUTING.md guide

Description

Add CONTRIBUTING.md section on running the fuzz targets locally

Related Issue

Closes #27

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📝 Documentation update
  • 🔧 Refactor (code change that neither fixes a bug nor adds a feature)
  • ⚡ Performance improvement
  • ✅ Test addition or update
  • 🏗️ CI/CD or build system change

Checklist

  • I have added or updated tests that prove my fix is effective or my feature works
  • cargo clippy --all-targets -- -D warnings passes with no warnings
  • cargo fmt --check passes with no formatting issues
  • cargo test --all-targets passes
  • cargo test --doc passes
  • I have updated documentation as needed (rustdoc, README, etc.)
  • I have updated the changelog (if applicable)
  • My changes do not introduce any new unsafe code (or it is properly justified and documented)

Additional Notes

Summary by CodeRabbit

  • Documentation
    • Added comprehensive fuzz testing guidance to the contribution documentation, including setup instructions, available fuzz targets, common run commands and flags, crash reproduction and minimization steps, recommended fuzzing durations, and dictionary usage tips.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 2904be0b-e222-40a1-9096-589aac6ccdc9

📥 Commits

Reviewing files that changed from the base of the PR and between 7220aff and 0baeb52.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

CONTRIBUTING.md now includes a Fuzz Testing section covering cargo-fuzz installation, available targets, execution commands, crash reproduction and minimization, recommended run durations, and dictionary usage.

Changes

Fuzz testing documentation

Layer / File(s) Summary
Document the fuzz testing workflow
CONTRIBUTING.md
Adds a table-of-contents link and contributor instructions for installing, running, and troubleshooting the repository’s fuzz targets.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The CONTRIBUTING.md update covers fuzz setup, targets, crash reproduction, and fuzzing duration, but clean-checkout verification is not evidenced. Verify the instructions on a clean checkout and note that verification in the PR or docs.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and related to the documentation change, though it is broader than the fuzz-testing focus.
Out of Scope Changes check ✅ Passed The pull request stays within documentation changes for fuzz testing and adds no unrelated code or scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between c192bc9 and 7220aff.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
@AteebNoOne
AteebNoOne merged commit 3b834cb into iTeebot:main Jul 21, 2026
24 checks passed
@anidroid1184
anidroid1184 deleted the doc/add-new-contributing-section branch July 21, 2026 18:48
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.

[Good First Issue]: Add CONTRIBUTING.md section on running the fuzz targets locally

2 participants