Skip to content

Commit a727cf3

Browse files
committed
Use OpenSSF instead of Security in name and add FAQ entry
Also rebased. Signed-off-by: Arnaud J Le Hors <[email protected]>
1 parent d1af71c commit a727cf3

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Security Scorecard
1+
# Contributing to OpenSSF Scorecard
22

3-
Thank you for contributing your time and expertise to the Security Scorecard
3+
Thank you for contributing your time and expertise to the OpenSSF Scorecard
44
project. This document describes the contribution guidelines for the project.
55

66
**Note:** Before you start contributing, you must read and abide by our

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Security Scorecard
1+
# OpenSSF Scorecard
22

33
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard/badge)](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard)
44
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/5621/badge)](https://bestpractices.coreinfrastructure.org/projects/5621)

cmd/root.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ import (
3636
)
3737

3838
const (
39-
scorecardLong = "A program that shows security scorecard for an open source software."
39+
scorecardLong = "A program that shows the OpenSSF scorecard for an open source software."
4040
scorecardUse = `./scorecard (--repo=<repo> | --local=<folder> | --{npm,pypi,rubygems}=<package_name>)
4141
[--checks=check1,...] [--show-details]`
42-
scorecardShort = "Security Scorecard"
42+
scorecardShort = "OpenSSF Scorecard"
4343
)
4444

4545
// New creates a new instance of the scorecard command.

docs/faq.md

+5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This page answers frequently asked questions about Scorecard, including its purp
55
## Installation / Usage
66
- [Can I preview my project's score?](#can-i-preview-my-projects-score)
77
- [What is the difference between Scorecard and other Code Scanning tools?](#what-is-the-difference-between-scorecard-and-other-code-scanning-tools)
8+
- [Wasn't this project called "Scorecards" (plural)?](#wasnt-this-project-called-scorecards-plural)
89

910
## Check-Specific Questions
1011
- [Binary-Artifacts: Can I allowlist testing artifacts?](#binary-artifacts-can-i-allowlist-testing-artifacts)
@@ -34,6 +35,10 @@ You can also use the CLI to generate scores for any public repository by followi
3435

3536
Most code scanning tools are focused on detecting specific vulnerabilities already existing in your codebase. Scorecard, however, is focused on improving the project's overall security posture by helping it adopt best practices. The best solution for your project may well be to adopt Scorecard along with other tools!
3637

38+
### Wasn't this project called "Scorecards" (plural)?
39+
40+
Yes, kind of. The project was initially called "Security Scorecards" but that form wasn't used consistently. In particular, the repo was named "scorecard" and so was the program. Over time people started referring to either form (singular and plural) and the inconsitency became prevalent. To end this situation the decision was made to consolidate over the use of the singular form in keeping with the repo and program name, drop the "Security" part and use "OpenSSF" instead to ensure uniqueness. One should therefore refer to this project as "OpenSSF Scorecard" or "Scorecard" for short.
41+
3742
## Check-specific Questions
3843

3944
### Binary-Artifacts: Can I allowlist testing artifacts?

0 commit comments

Comments
 (0)