docs+ci: ROADMAP + GOVERNANCE + coverage reporting (OpenSSF silver readiness) - #59
Conversation
…readiness) - ROADMAP.md: vision (edge-RAG / local-AI retrieval building block, NOT a standalone vector DB), non-goals, and direction (publish, C ABI, adapters incl. EdgeQuake, musllinux, 1.0). - GOVERNANCE.md: maintainer/code-owner roles, PR + review decision process, links to CONTRIBUTING/CoC/SECURITY. - coverage.yml + README badge: cargo-llvm-cov -> Codecov (tokenless, public repo; informational, non-blocking). Coverage is ~89% lines (measured with cargo llvm-cov --all-features; every file >= 80%). All actions SHA-pinned, persist-credentials: false, scoped permissions; zizmor + actionlint clean.
Review Summary by QodoAdd OpenSSF silver readiness: roadmap, governance, and coverage reporting
WalkthroughsDescription• Add ROADMAP.md defining ordvec as edge-RAG retrieval primitive, not standalone DB • Add GOVERNANCE.md with maintainer roles, PR review process, and contribution links • Implement coverage.yml workflow with cargo-llvm-cov and Codecov integration • Add Codecov badge to README for ~89% line coverage visibility Diagramflowchart LR
A["Project Vision<br/>ROADMAP.md"] --> B["Coverage Measurement<br/>cargo-llvm-cov"]
B --> C["Codecov Upload<br/>coverage.yml"]
C --> D["README Badge<br/>Public Coverage"]
E["Governance Model<br/>GOVERNANCE.md"] --> F["PR Review Process<br/>Branch Protection"]
F --> G["OpenSSF Silver<br/>Readiness"]
D --> G
File Changes1. ROADMAP.md
|
There was a problem hiding this comment.
Code Review
This pull request introduces project governance and roadmap documentation (GOVERNANCE.md and ROADMAP.md) and adds a Codecov badge to the README.md. The reviewer suggested a minor grammatical correction in the roadmap document to improve readability.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
There was a problem hiding this comment.
Pull request overview
This PR adds project governance/roadmap documentation and introduces CI coverage reporting to support OpenSSF Best Practices silver readiness.
Changes:
- Add
ROADMAP.mddefining ordvec’s scope (retrieval primitive) plus near/mid-term direction. - Add
GOVERNANCE.mddocumenting maintainer/code-owner roles and PR decision process. - Add a Codecov coverage workflow using
cargo-llvm-covand surface coverage via a README badge.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| ROADMAP.md | New roadmap capturing vision, non-goals, and planned direction toward 1.0 and supply-chain posture. |
| GOVERNANCE.md | New governance doc defining roles, decision-making, and links to contributing/conduct/security policies. |
| README.md | Adds Codecov badge to surface coverage reporting status. |
| .github/workflows/coverage.yml | New SHA-pinned workflow to generate lcov via cargo-llvm-cov and upload to Codecov without blocking PRs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- coverage.yml: switch the Codecov upload to token auth (CODECOV_TOKEN is now set) — the prior wiring had no supported auth path (Codex review). - .gitignore: add coverage output (lcov.info, *.profraw/*.profdata), the Playwright MCP session dir, common Python build/test artifacts, editor/OS cruft.
Toward the OpenSSF Best Practices silver badge (passing is already earned).
ROADMAP.md— the vision (ordvec as a retrieval primitive / building block for edge-deployed RAG and local AI retrieval, explicitly not a standalone vector DB), non-goals, and direction (coordinated publish, a C ABI for cross-stack embedding, adapters for host RAG stacks incl. EdgeQuake, musllinux wheels, the path to 1.0).GOVERNANCE.md— maintainer / code-owner roles, the PR + review decision process (branch protection: passing CI + 1 non-self code-owner review), and links to CONTRIBUTING / CoC / SECURITY.coverage.yml+ README badge —cargo-llvm-cov→ Codecov (tokenless, public repo; informational,fail_ci_if_error: falseso it never blocks a PR). Current coverage is ~89% lines (measured locally withcargo llvm-cov --all-features; every file ≥ 80%) — comfortably above silver's 80% bar.All actions SHA-pinned,
persist-credentials: false, scoped permissions;zizmor --offline+actionlintclean.One manual step for the badge: activate the repo at https://codecov.io (link the GitHub repo). Tokenless upload works for public repos; if Codecov ends up wanting a token, add a
CODECOV_TOKENrepo secret and the action will use it.