Skip to content

Commit

Permalink
uddating readme with criteria to add checks, removed motivation fluff (
Browse files Browse the repository at this point in the history
…#6)

Co-authored-by: Kim Lewandowski <klewandowski@google.com>
  • Loading branch information
kimsterv and Kim Lewandowski authored Oct 14, 2020
1 parent 4ed14b9 commit b24adb5
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# Open Source Scorecards

### Motivation
Consumers of open source projects need to understand the security posture of the software they depend on, and in many cases, have the ability to automate checks or policies using this data.
One proposed solution is to define a set of automate-able and objective data to produce a security "scorecard" for projects.
An organization could then create an internal policy such as "projects with a score less than X, need to be further reviewed."

In addition, this score is something that is actionable and can provide maintainers, contributors and other stakeholders concrete ways to improve the security posture of the projects they work or depend on.

A short motivational video clip to inspire us: https://youtu.be/rDMMYT3vkTk "You passed! All D's ... and an A!"

Expand Down Expand Up @@ -74,6 +69,13 @@ The following checks are all run against the target project:

To see detailed information on how each check works, see the check-specific documentation pages.

If you'd like to add a check, make sure it is something that meets the following criteria:
* automate-able
* objective
* actionable

and then create a new GitHub Issue.

## Results

Each check returns a pass/fail decision, as well as a confidence score between 0 and 10.
Expand Down

0 comments on commit b24adb5

Please sign in to comment.