Align repo state with v0.6.0 and rewrite README for accuracy - #19
Merged
Conversation
README — reflect the real current state and complexity:
- Rewrite around the actual ~28-module surface (orchestration, memory, learning,
security, reliability, distributed, observability, deployment) instead of the
6-file sketch that listed rust_brain.py / rule_fast.py (both are packages).
- Correct the public API to the real types: RouteDecision(tool/args/confidence/
escalated/source) not .action; step() -> {decision, compressed, stats};
recall() -> stored value; update_policy() -> bool; OutcomeType from hive.feedback.
- Correct compression labels to CORE/DISTILL/COMPACT/DROP/STALE/ESCALATE.
- Fix two broken code fences (Online Learning/Causal Memory; Development) that
swallowed whole sections.
- Fix wrong reproduce paths (scripts/, not hive/scripts/).
- Replace the unmeasured/contradictory ROI, case studies, and energy headline
with the real committed SWE-bench-lite A/B (85% resolve, -91.7% LLM calls).
Version drift:
- pyproject.toml: restore the missing [build-system] table and drop a stray
top-level version key; [project].version 0.5.0 -> 0.6.0.
- hive.__version__, FastAPI server, and Helm chart 0.5.0 -> 0.6.0.
- eval-result issue template placeholder -> v0.6.0.
(hive-cpp is a separately-versioned component and is intentionally left at 0.5.0.)
Citation / CI:
- Rewrite .github/citation.cff as valid CFF 1.2.0 (it was JSON with non-CFF fields).
- CI validates it with cffconvert instead of json.load (fixes "validating .cff as JSON").
Changelog:
- Add honest v0.6.0 CHANGELOG and RELEASE_NOTES entries.
Verified: 185 passed / 8 skipped (optional deps) locally; cffconvert --validate OK;
README code fences balanced; all README links resolve.
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
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
Aligns the repository with the v0.6.0 release and rewrites the README to reflect the real current state and complexity of the project. This addresses the drift around the v0.6.0 commit (which still reported
0.5.0in several places), a couple of broken-markdown / CI bugs, and a README that had grown inaccurate.README rewrite
The old README documented a 6-file sketch and an API that no longer matches the code. It now reflects what actually ships:
stack,async_stack), memory (rust_brainwith HLC,semantic_search), compression (rule_fast), learning (feedback,policy_updater,ab_test), security (authJWT/RBAC,encryption,model_registrysigned-joblib,audit_export,schemas), reliability (circuitbreaker,ratelimit,health), distributed (gossip,deployment), observability (telemetry,tracing,hardware), plusplugins,streaming,llm,config.RouteDecision(tool/args/confidence/escalated/source)(was.action);step() -> {decision, compressed, stats}(was{…, memories, metadata});recall() -> value;update_policy() -> bool;from hive.feedback import OutcomeType.CORE/DISTILL/COMPACT/DROP/STALE/ESCALATE(the README inventedCRITICAL/DEBUG/TOOL_OUTPUT/ERROR/INFO).scripts/…, nothive/scripts/…).docs/benchmarks/swebench-lite/hive-20260611T200319Z.json: 85% resolve, −91.7% LLM calls). Routing accuracy is framed as in-distribution with an explicit OOD caveat.Version drift
pyproject.toml: restored the missing[build-system]table and removed a stray top-levelversionkey;[project].version0.5.0→0.6.0.hive.__version__, the FastAPI server, and the Helm chart →0.6.0.v0.6.0.Citation / CI
.github/citation.cffwas JSON with non-CFF fields (citationFormat, schemastore$schema); rewritten as valid CFF 1.2.0 YAML.cffconvert --validateinstead ofjson.load(...)— fixes "CI validating.cffas JSON".Changelog
## [0.6.0]entries toCHANGELOG.mdandRELEASE_NOTES.md.Verification
pytest: 185 passed, 8 skipped (skips are optional-dependency integration tests).cffconvert --validate -i .github/citation.cff→ valid according to schema 1.2.0.Deliberate non-goals
docs/compliance-checklist.md,soc2-evidence.md,incident-response-runbook.md,rlhf-roadmap.md,MIGRATION.md,USAGE.md) still say0.5.0/2026-06-02. Blanket-bumping their as-of dates would falsify them; left for a separate docs pass if wanted.07a1c75commit message's "v0.3 definition of done" line is immutable history onmainand is not rewritten (would require a force-push to the default branch).