docs(problems): add a concrete trust scorecard artifact shape - #6633
Conversation
E2E tests did not runE2E tests run automatically for org/repo members and collaborators on pull requests. For other contributors, a maintainer must add the See E2E testing guide for details. |
PR Summary by QodoDocument trust scorecards and lint agent configurations in CI
AI Description
Diagram
High-Level Assessment
Files changed (2)
|
Code Review by Qodo
1.
|
04d4570 to
8938468
Compare
Site previewPreview: https://55e8f6c5-site.fullsend-ai.workers.dev Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
8938468 to
3e286f6
Compare
waynesun09
left a comment
There was a problem hiding this comment.
Review sweep on the new trust-scorecard section: 6 findings, all MEDIUM, posted inline.
They cluster around one theme — the section states four properties the artifact is supposed to guarantee (reproducible decisions, never-measured distinguishable from measured-weak, drift detection matching the per-dimension rules above, provenance per section 3), and in each case the shape as drawn does not yet carry the field that would make the property hold. Each comment names the specific line pair that disagrees and proposes either a field to add or a wording change to match what the shape actually does. All are docs-level; none is a merge blocker.
Comments only — no approval or change request implied.
|
This reads as an ADR to me. Are you trying to make a design decision or just show an example? Key words are raising this for me are basically "proposal" and "design". Frame it as an example used on other products, not as a design or proposal. |
Trustworthiness-evidence.md describes how evidence composes into a trust decision but not what that decision is recorded as. Show, as an illustration, how such a record looks, grounded in existing artifacts (OpenSSF Scorecard, in-toto/SLSA provenance): it binds the five evidence types to a config hash and carries per-signal provenance, freshness, and the composition outcome. Framed as an example, not a design proposal. Add one open question on where such a record lives and how long it stays valid. Signed-off-by: Benjamin Kapner <bkapner@redhat.com>
3e286f6 to
895bfa4
Compare
|
@rh-hemartin i've reframed it away from reading as a design or proposal. it now presents the record as an illustrative example, grounded in existing artifacts (OpenSSF Scorecard, in-toto/SLSA provenance), rather than a shape this repo is deciding on. dropped the "proposal" wording, the "design points" list, and the "alternatives considered" section. the doc's job here is to show what such a record can look like, not to pick one. |
waynesun09
left a comment
There was a problem hiding this comment.
Follow-up review at head 895bfa4: 1 finding, posted inline.
Addresses review: the scorecard section presented a single record shape with no alternatives, contrary to the docs/problems convention that problem docs present options with trade-offs. Restore the 'other representations' paragraph (flat signal->score map; one record per signal) with the cost of each, and frame the bound-record shape as one choice with consequences rather than a settled schema. Signed-off-by: Benjamin Kapner <bkapner@redhat.com>
Signed-off-by: Benjamin Kapner <bkapner@redhat.com>
Summary
trustworthiness-evidence.mddescribes the five evidence types and how they compose into a trust decision (threshold / weighted / tiered), but it never says what the decision is actually recorded as. This adds a concrete "trust scorecard" artifact: the serialized record that carries the evidence plus the resulting decision, so a trust decision is reproducible, auditable, and portable across the dispatch pipeline instead of living only in a reviewer's head.Related Issue
Extends the "Trustworthiness Evidence" problem area. No tracking issue; opening as an additive contribution to the problem doc.
Changes
## A concrete artifact: the trust scorecardsection between the composition models and the relationship section, with a proposed (not fixed) JSON shape that:config_hash(so a config change invalidates its signals, matching the drift-detection requirement);source+as_ofprovenance/freshness, so a stale or missing signal is visible rather than silently treated as a pass;statusseparate fromscore(present-but-weak vs. never-measured);blockingit, so aninsufficientdecision names the missing evidence instead of returning an opaque no.Scope is deliberately narrow: the scorecard makes the inputs and outcome explicit; it does not decide weights or thresholds (those stay with the composition model and
governance.md).Testing
Docs-only change. Rendered locally; internal links reuse targets already referenced by this doc (
governance.md,testing-agents.md, etc.).Checklist