Repository navigation
docs: add OSS governance files, versioning policy, refresh roadmap - #8
Merged
Merged
Conversation
Tier-2 project hygiene so the repo is approachable and trustworthy for outside contributors and users. Governance / community health: - CONTRIBUTING.md: setup, the spec-first OpenSpec workflow, what a mergeable PR looks like (tests + regression test for bugs, green CI, docs/specs in sync, readable low-complexity code), and numerical-correctness expectations. - SECURITY.md: private vulnerability reporting (GitHub advisories / email), supported-versions table, scope. - CODE_OF_CONDUCT.md: Contributor Covenant 2.1. - CHANGELOG.md: Keep a Changelog format; [Unreleased] + the 0.0.1 release. - .github issue forms (bug / feature), issue chooser config (security + discussions links), and a pull-request template. Trust / clarity: - README: a "Versioning & API stability" section (pre-1.0, SOVERSION-pinned C ABI) and links to the new governance files. - docs/roadmap.md: mark M1/M2/M4 done and M3 done-except-SYCL (they had shipped but were unmarked); fix the broken bootstrap-change link; add the real remaining work (SYCL, mobile + bindings GA, pip wheel, drag/lift, Conan/vcpkg). openspec validate --all --strict passes (14/14).
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
1 participant
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.
Summary
Tier-2 (OSS hygiene & trust) — the community-health and clarity files that make the repo approachable for outside contributors and users.
Added
CONTRIBUTING.mdSECURITY.mdCODE_OF_CONDUCT.mdCHANGELOG.md[Unreleased]+ the0.0.1release.github/ISSUE_TEMPLATE/*.github/PULL_REQUEST_TEMPLATE.mdChanged
SOVERSION-pinned C ABI) + links to the governance files.docs/roadmap.md— the roadmap was stale: M1/M2/M4 had shipped but were unmarked, M3 is done except SYCL. Marked accurately, fixed the brokenbootstrap-cyberfluids-corelink (now points intoarchive/), and listed the real remaining work: SYCL, mobile + bindings GA, a self-contained pip wheel, drag/lift reporting, and Conan/vcpkg packaging.Testing
openspec validate --all --strict→ 14/14.Context
Completes Tier 1 + Tier 2 from the project-health review. The one deliberately-deferred item is the self-contained Python wheel (Tier 1 #3), now tracked on the roadmap under M5 — it deserves its own PR with clean-venv
pip installvalidation, and the install/export groundwork from #7 is what it builds on.