add fuzz target and basic docs on how to run it (#450)

Byron · Aug 7, 2022 · febf070 · febf070
1 parent 62d721a
commit febf070
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/git-refspec/README.md b/git-refspec/README.md
@@ -0,0 +1,11 @@
+# `git-refspec`
+
+### Testing
+
+#### Fuzzing
+
+`cargo fuzz` is used for fuzzing, installable with `cargo install cargo-fuzz`.
+
+Targets can be listed with `cargo fuzz list` and executed via `cargo +nightly fuzz run <target>`,
+where `<target>` can be `parse` for example.
+
diff --git a/git-revision/Cargo.toml b/git-revision/Cargo.toml
@@ -6,7 +6,7 @@ license = "MIT/Apache-2.0"
 description = "A WIP crate of the gitoxide project dealing with finding names for revisions and parsing specifications"
 authors = ["Sebastian Thiel <sebastian.thiel@icloud.com>"]
 edition = "2018"
-include = ["src/**/*", "CHANGELOG.md"]
+include = ["src/**/*", "CHANGELOG.md", "README.md"]
 
 [lib]
 doctest = false

diff --git a/git-revision/README.md b/git-revision/README.md
@@ -0,0 +1,11 @@
+# `git-revision`
+
+### Testing
+
+#### Fuzzing
+
+`cargo fuzz` is used for fuzzing, installable with `cargo install cargo-fuzz`.
+
+Targets can be listed with `cargo fuzz list` and executed via `cargo +nightly fuzz run <target>`,
+where `<target>` can be `parse` for example.
+