Skip to content

docs+ci: ROADMAP + GOVERNANCE + coverage reporting (OpenSSF silver readiness) - #59

Merged
Navi Bot (project-navi-bot) merged 2 commits into
mainfrom
docs/silver-readiness
May 25, 2026
Merged

docs+ci: ROADMAP + GOVERNANCE + coverage reporting (OpenSSF silver readiness)#59
Navi Bot (project-navi-bot) merged 2 commits into
mainfrom
docs/silver-readiness

Conversation

@Fieldnote-Echo

Copy link
Copy Markdown
Member

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 badgecargo-llvm-cov → Codecov (tokenless, public repo; informational, fail_ci_if_error: false so it never blocks a PR). Current coverage is ~89% lines (measured locally with cargo llvm-cov --all-features; every file ≥ 80%) — comfortably above silver's 80% bar.

All actions SHA-pinned, persist-credentials: false, scoped permissions; zizmor --offline + actionlint clean.

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_TOKEN repo secret and the action will use it.

…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.
@qodo-code-review

Copy link
Copy Markdown

Review Summary by Qodo

Add OpenSSF silver readiness: roadmap, governance, and coverage reporting

📝 Documentation ✨ Enhancement

Grey Divider

Walkthroughs

Description
• 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
Diagram
flowchart 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

Loading

File Changes

1. ROADMAP.md 📝 Documentation +61/-0

Project vision and strategic direction document

• Defines ordvec as a retrieval primitive for edge-deployed RAG and local AI, explicitly not a
 standalone vector DB
• Lists non-goals: no billion-scale ANN, distributed serving, query language, or persistence
 machinery
• Outlines direction: coordinated publish, C ABI for cross-stack embedding, adapters for RAG systems
 like EdgeQuake, musllinux wheels, and path to 1.0
• Emphasizes training-free encoding, zero system dependencies, predictable footprint, and
 runtime-dispatched SIMD

ROADMAP.md


2. GOVERNANCE.md 📝 Documentation +42/-0

Maintainer roles and PR review governance

• Establishes maintainer role (Nelson Spence as project lead and final decision-maker)
• Defines code-owner roles with review and approval responsibilities
• Specifies decision-making process: all changes via PR, passing CI required, one non-author
 code-owner approval needed
• Links to CONTRIBUTING, CODE_OF_CONDUCT, and SECURITY documents

GOVERNANCE.md


3. .github/workflows/coverage.yml ⚙️ Configuration changes +44/-0

Coverage measurement and Codecov integration workflow

• Implements cargo-llvm-cov for test coverage measurement with all features enabled
• Configures Codecov upload with tokenless authentication for public repos
• Sets fail_ci_if_error to false to keep coverage reporting informational and non-blocking
• SHA-pins all actions (harden-runner, checkout, rust-toolchain, rust-cache, codecov-action) with
 scoped permissions

.github/workflows/coverage.yml


View more (1)
4. README.md 📝 Documentation +1/-0

Add Codecov coverage badge to README

• Adds Codecov badge linking to coverage dashboard
• Badge displays current ~89% line coverage (measured with cargo llvm-cov --all-features)
• Positioned alongside existing MSRV, OpenSSF Scorecard, and Best Practices badges

README.md


Grey Divider

Qodo Logo

@qodo-code-review

qodo-code-review Bot commented May 25, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread ROADMAP.md
@codecov

codecov Bot commented May 25, 2026

Copy link
Copy Markdown

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 ☂️

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md defining ordvec’s scope (retrieval primitive) plus near/mid-term direction.
  • Add GOVERNANCE.md documenting maintainer/code-owner roles and PR decision process.
  • Add a Codecov coverage workflow using cargo-llvm-cov and 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.
@project-navi-bot
Navi Bot (project-navi-bot) merged commit 0ae62e0 into main May 25, 2026
20 checks passed
@project-navi-bot
Navi Bot (project-navi-bot) deleted the docs/silver-readiness branch May 25, 2026 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants