Add check for OSPS-DO-03: repo contains end-user documentation #232
Conversation
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
evankanderson
force-pushed
the
osps-do-03
branch
from
5c9ea6a to
dade4e1
Compare
JAORMX
reviewed
Dec 19, 2024
| * A `README.md` file containing preformatted text (triple-backtick) or the headings | ||
| "usage" or "getting started" | ||
|
|
||
| For more information, see [OpenSSF Security Baseline](https://baseline.openssf.org/#osps-do-03). |
There was a problem hiding this comment.
The guidance is not meant to describe the rule type itself, but instead, to indicate what to do in case of failure. This should be moved to the description and we should tell the user what to do in case this fails.
There was a problem hiding this comment.
Does that apply to the last sentence, or the whole current guidance?
There was a problem hiding this comment.
This while guidance felt more like a description
There was a problem hiding this comment.
Does this read better?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a proposed implementation of https://baseline.openssf.org/#osps-do-03
Ideally, remediation would include creating or updating SECURITY-INSIGHTS.md, but we don't quite have those capabilities yet. I've included a sample of what we are able to do at the moment, but we'd want to be able to feed the set of discovered documentation locations into the documentation field in security-insights if not set.