Conversation
… dogfood note Three shrink-and-document moves toward a leaner pre-1.0 public surface: - evidence-core lib.rs splits re-exports into a curated public surface and a #[doc(hidden)] implementation-detail block. ~38 leaf items (BoundaryViolation, BranchCoverage, FixHint, sha256, rules_json, TraceMeta, etc.) drop off rustdoc but stay reachable for workspace callers and contract tests via their owning module path. Curated surface is now ~36 items grouped by external use case (verify, build, compliance, trace, rules, coverage thresholds). - schema_versions.rs and README "Project Status" spell out that the on-disk `schema_version` field is informational during pre-1.0: pinned at 0.0.1 across breaking shape changes, not a compatibility contract. Consumers should pin a `cargo-evidence` workspace version (read `engine_crate_version` in index.json) instead of pattern- matching the literal. - CONTRIBUTING gains a "Dogfooding doctor / hint / MCP behavior changes" section: the installed binary on $PATH is the wrong test target when iterating on user-facing output. Use `cargo run --bin cargo-evidence -- evidence doctor` for direct CLI changes; `cargo install --path crates/cargo-evidence --path crates/evidence-mcp --force` before re-invoking the MCP wrapper. MCP_VERSION_SKEW only catches binary-vs-binary drift, not workspace- vs-binary drift. No code-behavior change; rustdoc-only and docs-only edits. Local fmt/clippy/doc/test/trace/floors all green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Three shrink-and-document moves toward a leaner pre-1.0 public surface, no code-behavior change:
evidence-corelib.rs: re-exports split into a curated public surface (~36 items, grouped by external use case) and a#[doc(hidden)]implementation-detail block (~38 leaf items:BoundaryViolation,BranchCoverage,FixHint,sha256,rules_json,TraceMeta, etc.). Hidden items stay reachable via their owning module path for workspace callers and contract tests; they drop off rustdoc.schema_versions.rs+ README "Project Status": spell out that the on-diskschema_versionfield is informational during pre-1.0 — pinned at0.0.1across breaking shape changes, not a compatibility contract. Consumers should pin acargo-evidenceworkspace version (readengine_crate_versioninindex.json) instead of pattern-matching the literal.CONTRIBUTING.md: new "Dogfooding doctor / hint / MCP behavior changes" section. The installed binary on$PATHis the wrong test target when iterating on user-facing output. Usecargo run --bin cargo-evidence -- evidence doctorfor direct CLI work;cargo install --path crates/cargo-evidence --path crates/evidence-mcp --forcebefore re-invoking the MCP wrapper.MCP_VERSION_SKEWcatches binary-vs-binary drift but not workspace-vs-binary drift.This is the first of two planned pre-1.0-honesty PRs. The follow-up (separate) renames the HMAC envelope away from "signature" terminology (
sign_bundle→compute_bundle_mac,BUNDLE.sig→BUNDLE.mac, SYS-001 wording) so the project stops calling a shared-secret MAC a digital signature. That PR will trip the cross-time determinism gate and will use theOverride-Deterministic-Baseline:protocol; this one does not.Test plan
cargo fmt --checkcargo clippy --workspace --all-targets -- -D warningscargo test --workspace --all-targets(all green;floors_equal_current_no_slackpasses)RUSTDOCFLAGS='-D missing_docs -D rustdoc::broken_intra_doc_links' cargo doc --workspace --no-depscargo evidence trace --validate→TRACE_OKcargo evidence floors --format=jsonl→FLOORS_OKcargo evidence doctor→ noDOCTOR_FLOORS_SLACK, all checks[✓]🤖 Generated with Claude Code