Skip to content

docs: add governance, roadmap, and security docs for OpenSSF Silver - #397

Draft
joshua-temple wants to merge 3 commits into
feat/ossf-coverage-gatefrom
feat/ossf-silver-docs
Draft

docs: add governance, roadmap, and security docs for OpenSSF Silver#397
joshua-temple wants to merge 3 commits into
feat/ossf-coverage-gatefrom
feat/ossf-silver-docs

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

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/*.md files sit at the docs/ root, which the Astro Starlight site does not source (its loader globs only docs/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 ./... and go test ./... pass (docs-only change).
  • Astro docs site builds unchanged (17 pages; root markdown correctly ignored).
  • All relative links resolve; guardrails clean.

Maintainer follow-ups (in the docs as placeholders)

  • Fill the Code of Conduct reporting contact.
  • Continuity plan: designate a backup maintainer, place the signing key and passphrase in an org-controlled lockbox, and confirm org owners can restore repo access.

@joshua-temple
joshua-templeforce-pushed the feat/ossf-coverage-gate branch from 1646254 to 659a0c3CompareJune 27, 2026 15:59
@joshua-temple
joshua-templeforce-pushed the feat/ossf-silver-docs branch 2 times, most recently from 42a6d2d to b7c0d1eCompareJune 27, 2026 16:07
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-templeforce-pushed the feat/ossf-coverage-gate branch from 659a0c3 to 5a49f23CompareJune 27, 2026 16:26
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-templejoshua-temple added the docs Improvements or additions to documentation label Jun 27, 2026
@joshua-temple
joshua-templeforce-pushed the feat/ossf-coverage-gate branch from 5a49f23 to 3625c6cCompareJune 30, 2026 20:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@joshua-temple