securesauce / precaution-beta

Precaution provides a simple, automated code review for GitHub projects by running code linters with a security focus on pull requests.
Other
1 stars 0 forks source link

Add doc for what issues Precaution catch #242

Closed MVrachev closed 4 years ago

MVrachev commented 5 years ago

When a user sees our repository it's important to give good argumentation about why he should use our app. Having documentation which roughly groups what issues are found by Precaution is a good and valid argument for that

Closes: https://github.com/vmware/precaution/issues/178

Signed-off-by: Martin Vrachev mvrachev@vmware.com

codecov-io commented 5 years ago

Codecov Report

Merging #242 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master    #242   +/-   ##
======================================
  Coverage    98.3%   98.3%           
======================================
  Files          18      18           
  Lines         355     355           
  Branches       38      38           
======================================
  Hits          349     349           
  Misses          6       6

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update a1f47ed...5411567. Read the comment docs.

MVrachev commented 5 years ago

I updated my pr with the suggestions from comment: https://github.com/vmware/precaution/pull/242#pullrequestreview-270241222