Skip to content

Commit

Permalink
docs: add documentation for scorecards (#132)
Browse files Browse the repository at this point in the history
* docs: add documentation for scorecards
  • Loading branch information
PierreDemailly authored Jan 4, 2023
1 parent e99517a commit 0a22ba0
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ The CLI allow to load the JSON into a Webpage with the **open** command. The pag
- Link vulnerabilities from the [Security-WG repository](https://github.com/nodejs/security-wg/tree/master/vuln/npm) to the package version node.
- Add flags to each packages versions to identify well known patterns and potential security threats easily.
- Analyze npm packages and local Node.js projects.
- Supports [OpenSSF Scorecard](https://github.com/ossf/scorecard).

## 🚧 Requirements

Expand Down Expand Up @@ -180,6 +181,11 @@ Nodes are red when the project/package has been flagged with 🔬 `hasMinifiedCo
Node-secure will analyze the complete size of the npm tarball with no filters or particular optimization. Bundlephobia on the
other side will bundle and remove most of the useless files from the tarball (Like the documentation, etc.).

### Why some packages don't have OSSF Scorecard ?
See [Scorecard Public Data](https://github.com/ossf/scorecard#public-data):
> We run a weekly Scorecard scan of the 1 million most critical open source projects judged by their direct dependencies and publish the results in a BigQuery public dataset.
> Currently, this list is derived from projects hosted on GitHub ONLY.
## Contributors ✨

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
Expand Down

0 comments on commit 0a22ba0

Please sign in to comment.