From 3bce510ef1fe57977136270f2671ff974fbc183d Mon Sep 17 00:00:00 2001 From: Ammar Askar Date: Wed, 4 Sep 2019 23:50:17 -0400 Subject: [PATCH] [docs] Document shiny new badge in the docs (#2700) * [docs] Document shiny new badge in the docs Use monorail project link instead of build logs Monorail link has advantage of showing previously found bugs. It also shows any build failures (though the issue may be hard to find in long-lasting build failures). The link sorts by date a bug was opened, thus some verified bugs will be shown before more recently opened ones. --- docs/getting-started/new_project_guide.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/getting-started/new_project_guide.md b/docs/getting-started/new_project_guide.md index bc76f8295..317025ada 100644 --- a/docs/getting-started/new_project_guide.md +++ b/docs/getting-started/new_project_guide.md @@ -414,3 +414,19 @@ Use the [ClusterFuzz web interface](https://oss-fuzz.com/) to review the followi * Fuzzer performance analyzer (linked from fuzzer statistics) **Note:** Your Google Account must be listed in [project.yaml](#projectyaml) for you to have access to the ClusterFuzz web interface. + +### Status Badge + +![Example +Badge](https://oss-fuzz-build-logs.storage.googleapis.com/badges/curl.svg) + +Once your project has started [building](https://oss-fuzz-build-logs.storage.googleapis.com/index.html), we'd love it if you added our badge in +your project's README. This allows you to see bugs found by your OSS-Fuzz +integration at a glance. See +[brotli](https://github.com/google/brotli#introduction)'s +README for an example. + +Adding it is super easy, just follow this template: +```markdown +[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:) +```