forked from nvm-sh/nvm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[security] add prose explaining OpenSSF CII Best Practices badge results
- Loading branch information
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,23 @@ | ||
# Security | ||
|
||
Please email [@ljharb](https://github.com/ljharb) or see https://tidelift.com/security if you have a potential security vulnerability to report. | ||
|
||
## OpenSSF CII Best Practices | ||
|
||
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/684/badge)](https://bestpractices.coreinfrastructure.org/projects/684) | ||
|
||
There are three “tiers”: passing, silver, and gold. | ||
|
||
### Passing | ||
We meet 100% of the “passing” criteria. | ||
|
||
### Silver | ||
We meet 95% of the “silver” criteria. The gaps are as follows: | ||
- we do not have a DCO or a CLA process for contributions. | ||
- because we only have one maintainer, the project has no way to continue if that maintainer stops being active. | ||
- 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. | ||
|
||
### Gold | ||
We meet 65% of the “gold” criteria. The gaps are as follows: | ||
- we do not yet have the “silver” badge; see all the gaps above. | ||
- 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. |