Update baseline.yaml - NEW - OSPS-DO-14 #117
Open
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
suggested wording for OSPS-DO-14 Signed-off-by: CRob <69357996+SecurityCRob@users.noreply.github.com>
SecurityCRob
added
documentation
Comment on lines
+656
to
+662
| The project documentation MUST provide a | ||
| descriptive statement when releases or | ||
| versions are no longer supported and that | ||
| will no longer receive security updates. | ||
|
|
||
| This should be provided both in human and | ||
| machine-readable formats. |
There was a problem hiding this comment.
- Do we mean "should" or "SHOULD" in the second sentence? If it's the "normal English 'should'", maybe we actually mean "MUST" instead? (Personally, I lean toward SHOULD, but I want to make sure I understand your intent)
- As a rule, I don't like the idea of multi-sentence criteria and definitely not multi-paragraph (in the
<p>sense, not in the English sense). Could it be be re-written as "The project documentation MUST provide human- and machine-readable descriptive statements when releases are no longer supported and will not longer receive security updates"? (As a note, I condensed "releases or versions" to be "releases" because I'm not entirely clear that there's a meaningful distinction between the two). Or, if the intent was for having both human- and machine-readable be a strong suggestion but not a requirement, then we should move the second sentence into the implementation (which it sort of already is)
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.
suggested wording for OSPS-DO-14 for End-Of-Support statement