Rooba
/
oss-fuzz
mirror of https://github.com/google/oss-fuzz.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[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.
This commit is contained in:
Ammar Askar 2019-09-04 23:50:17 -04:00 committed by jonathanmetzman
parent d4e5d489e4
commit 3bce510ef1
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/getting-started/new_project_guide.md
View File

@ -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/<project>.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:<project>)
```