Skip to content

Commit 0128aca

Browse files
Clarify project goals and add a section on non-goals (#4318)
Signed-off-by: Spencer Schrock <[email protected]>
1 parent fef0512 commit 0128aca

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,36 @@ The inspiration for Scorecard’s logo:
8282
1. Use this data to proactively improve the security posture of the critical
8383
projects the world depends on.
8484

85+
1. Act as a measurement tool for existing policies
86+
87+
If OSS consumers require certain behaviors from their dependencies,
88+
Scorecard can be used to measure those. With the V5 release, we see
89+
Structured Results as a way of doing this if there is a supported analysis.
90+
Instead of relying on an aggregate score of X/10, or a Maintained score of
91+
Y/10, an OSS consumer may want to ensure the repo they're depending on
92+
isn't archived (which is covered by the `archived` probe). The OpenSSF
93+
takes this approach with its own Security Baseline for projects.
94+
95+
#### Project Non-Goals
96+
97+
1. To be a definitive report or requirement that all projects should follow.
98+
99+
Scorecard is not intended to be a one-size-fits-all solution. Every step of
100+
making our results is opinionated: what checks get included or excluded,
101+
the importance of each check, and how scores are calculated. The checks
102+
themselves are heuristics; there are false positives and false negatives.
103+
104+
Whether it’s due to applicability, or feasibility, or a matter of opinion,
105+
what's included or excluded from Scorecard results leads to a lot of
106+
discussion. It’s impossible to create a Scorecard that satisfies everyone
107+
because different audiences will care about different subsets of behavior.
108+
109+
Aggregate scores in particular tells you nothing about what individual
110+
behaviors a repository is or is not doing. Many check scores are aggregated
111+
into a single score, and there’s multiple ways of arriving at the same
112+
score. These scores change as we add new heuristics or refine the existing
113+
ones.
114+
85115
### Prominent Scorecard Users
86116

87117
Scorecard has been run on thousands of projects to monitor and track security

0 commit comments

Comments
 (0)