Skip to content

Commit a25a2f6

Browse files
committed
Add a blurb about C-Smith fuzzing to CONTRIBUTING.md
And link to the csmith-fuzzing/README.md file for more details. Fixes #1038
1 parent e03d6fa commit a25a2f6

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ out to us in a GitHub issue, or stop by
1919
- [Testing a Single Header's Bindings Generation and Compiling its Bindings](#testing-a-single-headers-bindings-generation-and-compiling-its-bindings)
2020
- [Authoring New Tests](#authoring-new-tests)
2121
- [Test Expectations and `libclang` Versions](#test-expectations-and-libclang-versions)
22+
- [Fuzzing `bindgen` with `csmith`](#fuzzing-bindgen-with-csmith)
2223
- [Code Overview](#code-overview)
2324
- [Pull Requests and Code Reviews](#pull-requests-and-code-reviews)
2425
- [Generating Graphviz Dot Files](#generating-graphviz-dot-files)
@@ -193,6 +194,14 @@ Where `$VERSION` is one of:
193194

194195
depending on which version of `libclang` you have installed.
195196

197+
### Fuzzing `bindgen` with `csmith`
198+
199+
We <3 finding hidden bugs and the people who help us find them! One way to help
200+
uncover hidden bugs is by running `csmith` to generate random headers to test
201+
`bindgen` against.
202+
203+
See [./csmith-fuzzing/README.md](./csmith-fuzzing/README.md) for details.
204+
196205
## Code Overview
197206

198207
`bindgen` takes C and C++ header files as input and generates corresponding Rust

0 commit comments

Comments
 (0)