Skip to content

README.md

Latest commit

 

History

History
27 lines (23 loc) · 2.61 KB

README.md

File metadata and controls

27 lines (23 loc) · 2.61 KB
Raw

Documentation

Languages: English | Português (Brasil)

Keep the root README.md as the project entry point and place deeper design material here.

  • architecture/ — current architecture, contracts, and implementation design.
  • classification.md — deterministic project classification rules and precedence.
  • configuration.md — optional repository configuration, exclusions, classification overrides, and precedence.
  • diagnostics.md — stable diagnostic catalog and operational logging rules.
  • security.md — data collection boundary, MSBuild trust model, secret handling, Action permissions, and sink credential guidance.
  • persistence.md — optional snapshot persistence, sink extension contract, timeout, failure mode, and retry boundary.
  • snapshot-provenance.md — evidence identity, UTC provenance, report digest, and idempotency semantics.
  • inspection-engine.md — end-to-end inspection orchestration, failure semantics, determinism, and cancellation.
  • cli.md — command-line usage, output streams, exit codes, and cancellation behavior.
  • github-action.md — reusable GitHub Action inputs, outputs, runtime bootstrap, permissions, and CI validation.
  • container.md — local container build, SDK matrix, hardened mounts, non-root execution, and offline usage.
  • releases.md — Semantic Versioning, schema compatibility, protected publication, release artifacts, tags, and provenance.
  • v1-release-readiness.md — v1.0.0 public baseline, automated readiness gate, first-publication checklist, and post-release verification.
  • compatibility.md — supported .NET SDK/TFM and operating-system compatibility matrix.
  • performance.md — synthetic large-repository baseline, measured hotspots, and regression guardrails.
  • real-repository-validation.md — pinned public-repository validation harness and bug-reproduction policy.
  • project-reference-graph.md — normalized ProjectReference graph semantics.
  • schema/inspection-v1.md — public JSON contract and compatibility policy.
  • decisions/ — Architecture Decision Records for durable technical decisions.

Documentation distinguishes the public v1 compatibility surface from explicitly post-v1 evolution work.