Skip to content

decision/adr: record SemVer, template distribution, API versioning, container image, and cross-link strategy #140

@cdcavell

Description

@cdcavell

Context

The v1.0.0 tag creates a SemVer commitment. The readiness assessment recommends recording several architectural decisions before the release so future changes are easier to classify and defend.

Acceptance Criteria

  • ADR records the SemVer public surface for the template.
  • ADR classifies which changes are MAJOR, MINOR, or PATCH for:
    • scaffolded project layout,
    • template parameters/symbols,
    • configuration key names/defaults,
    • default API route conventions,
    • default middleware ordering,
    • container image tag conventions,
    • internal class signatures.
  • ADR records the template distribution model: NuGet-published dotnet new install vs clone-and-modify.
  • ADR records the default API versioning scheme and rationale.
  • ADR records the container base image strategy and tradeoffs.
  • ADR records whether Zenodo/metadata should cross-link this repository to related SSRN works, and if so, what relationship type is appropriate.
  • README and DocFX links point to these ADRs where release behavior depends on them.

Related

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions