Skip to content

Commit 2426a0c

Browse files
committed
[security] add prose explaining OpenSSF CII Best Practices badge results
Fixes openjs-foundation/security-collab-space#35.
1 parent 8a83b36 commit 2426a0c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

.github/SECURITY.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
# Security
22

33
Please email [@ljharb](https://github.com/ljharb) or see https://tidelift.com/security if you have a potential security vulnerability to report.
4+
5+
## OpenSSF CII Best Practices
6+
7+
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/684/badge)](https://bestpractices.coreinfrastructure.org/projects/684)
8+
9+
There are three “tiers”: passing, silver, and gold.
10+
11+
### Passing
12+
We meet 100% of the “passing” criteria.
13+
14+
### Silver
15+
We meet 95% of the “silver” criteria. The gaps are as follows:
16+
- we do not have a DCO or a CLA process for contributions.
17+
- because we only have one maintainer, the project has no way to continue if that maintainer stops being active.
18+
- we do not currently document “what the user can and cannot expect in terms of security” for our project. This is planned to be completed in 2023.
19+
20+
### Gold
21+
We meet 65% of the “gold” criteria. The gaps are as follows:
22+
- we do not yet have the “silver” badge; see all the gaps above.
23+
- We do not include a copyright or license statement in each source file. Efforts are underway to change this archaic practice into a suggestion instead of a hard requirement.

0 commit comments

Comments
 (0)