Repository navigation
spec: add portable "consumability" readiness rubric - #10
Merged
Merged
Conversation
Consolidate the "a library is usable by others" requirements into one self-contained OpenSpec capability so it can be lifted into other projects as an adoption checklist. Previously these were split across build-and-packaging (the build/install/CI/benchmark requirements) with the governance/versioning items not captured as requirements at all. The consumability spec states project-agnostic readiness requirements: - Consumable installed package (find_package-style discovery, namespaced targets) - Low-friction source build (one command, deps auto-resolved/pinned) - Language-ecosystem packages that build + bundle the native library - CI gate blocking merges on failure - Documented, reproducible performance references - Versioning + API-stability policy (semver, SOVERSION, changelog) - Governance & community-health files (license, contributing, CoC, security, templates) - Onboarding documentation kept truthful to the code Linked from the features matrix. openspec validate --all --strict passes (15/15).
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
Consolidates the "a library is usable by others" requirements into a single, self-contained OpenSpec capability —
openspec/specs/consumability— written project-agnostically so it can be lifted into other projects as an adoption checklist.Why
The build/install/CI/benchmark improvements from PRs #4–#9 were captured only inside
build-and-packaging(mixed with internal build mechanics), and the governance/versioning items (CONTRIBUTING, SECURITY, CoC, changelog, semver policy) were shipped as files but never captured as requirements. This spec gathers them all in one readiness rubric.The rubric (8 requirements, each with scenarios)
find_package-style discovery, namespaced targets, no vendoringSOVERSION, changelogEvery requirement maps to something Cyberfluids now satisfies (PRs #4–#9), so the spec doubles as this project's readiness record and a reusable checklist.
Notes
features.mdcapability matrix.openspec validate --all --strict→ 15/15.build-and-packagingat the readiness level (it references the detailed mechanics there) — the point is a portable, standalone rubric.