search

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

Change architecture diagram #244

Closed MVrachev closed 4 years ago

MVrachev commented 5 years ago

With the addition of the configuration options, we need to add those changes to the diagram because currently, it doesn't represent the Precaution control flow correctly.

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

MVrachev commented 5 years ago

So the diagram changes might not be obvious what you're trying to convey. Putting "..." is typically used in math or programming to indicate 0 to n. But in a diagram it looks more like a dotted line indicating some kind of relationship between GoSec and TSLint.

Then what options do we have? Use a magical box called “spawn linters” without explicitly showing that we start a new thread for every linter? How can we show that we start different threads for every linter and still make the diagram easy to understand?

joshuagl commented 5 years ago

We only have the 3 linters for now. Let's drop the ellipses between Gosec and TSLint then merge this change.

MVrachev commented 4 years ago

I updated my pr based on the feedback provided by @joshuagl with comment https://github.com/vmware/precaution/pull/244#issuecomment-526512813

codecov-io commented 4 years ago

Codecov Report

Merging #244 into master will decrease coverage by <.01%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           master    #244      +/-   ##
=========================================
- Coverage    98.3%   98.3%   -0.01%     
=========================================
  Files          18      18              
  Lines         355     353       -2     
  Branches       38      38              
=========================================
- Hits          349     347       -2     
  Misses          6       6
Impacted Files Coverage Δ
merge_reports.js 100% <0%> (ø) :arrow_up:

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 af2e181...1661b50. Read the comment docs.