docs: add governance, roadmap, and security docs for OpenSSF Silver#397
Draft
joshua-temple wants to merge 1 commit into
Draft
docs: add governance, roadmap, and security docs for OpenSSF Silver#397joshua-temple wants to merge 1 commit into
joshua-temple wants to merge 1 commit into
Conversation
1646254 to
659a0c3
Compare
42a6d2d to
b7c0d1e
Compare
659a0c3 to
5a49f23
Compare
Signed-off-by: Joshua Temple <[email protected]>
b7c0d1e to
adc5dc2
Compare
This file contains hidden or 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
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.
Problem
The OpenSSF Best Practices Silver criteria require a set of project documents cascade does not yet have: a code of conduct, a documented governance and roles model, a continuity and succession plan, a public roadmap, a security-requirements statement, and an assurance case (threat model and trust boundaries). The contribution docs also need an explicit test policy and coding standard.
Stacked on #396.
Fix
CODE_OF_CONDUCT.md(Contributor Covenant) at the repo root.GOVERNANCE.md: decision model, roles and who holds them, and a continuity and succession plan.ROADMAP.md: public direction covering the next year, including explicit non-goals.docs/security-requirements.md: the security goals and trust model users can rely on.docs/assurance-case.md: threat model, trust boundaries, secure-design argument, and the argument that common weaknesses are countered.CONTRIBUTING.md: added a test policy (tests required for new functionality, e2e scenarios for generator changes) and a coding-standard section.README.md: a Project governance section linking the new documents.The new
docs/*.mdfiles sit at thedocs/root, which the Astro Starlight site does not source (its loader globs onlydocs/src/content/docs/), so they are reachable via stable GitHub URLs without affecting the docs site. Architecture references point to the existing architecture documentation rather than duplicating it.Verification
go build ./...andgo test ./...pass (docs-only change).Maintainer follow-ups (in the docs as placeholders)