Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Schema: exhaustiveness/disjointness markers for subtypeOf (sealed/abstract)

Aperta
  • Qualcosa non va?
#24 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
go
Ambito
tooling

Direzione di ricerca

Inizia da ADR-0004 e dall’implementazione esistente di subtypeOf per comprendere lo schema e le convenzioni di validazione. Poi segui la sezione sulla gerarchia Markdown e i controlli correlati descritti nell’issue. Il lavoro è completato quando i genitori astratti non possono essere usati come istanze concrete e i genitori sealed presentano i propri sottotipi come un’enumerazione chiusa, con test che coprono entrambi i marker.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

ADR-0004 deferred exhaustiveness and disjointness markers (sealed, abstract) "until a second model needs them". This is a report that a second model needs them.

The use case

A model of a software-development methodology: the artifacts a team's process produces, and how they relate. One entity is a Commitment — a decision an agent must not re-make — which is exactly one of two kinds:

  • Invariant — a property of the artifact, mechanically checkable. For example "dependencies point inward only", enforced by an import-graph test plus a linter allowlist.
  • Practice — a behavioural or process rule that no test can check. For example "never edit a test to make it pass", or "rebase, never merge". Enforceable by a hook or a review step, or not at all.

subtypeOf (thank you, #8/#21) expresses the hierarchy, and having the parent's invariants cover both children is exactly right. Two things it cannot say:

  1. Exhaustive. Invariant and Practice are the complete enumeration. Nothing stops a bare Commitment that is neither.
  2. Abstract. A Commitment should never be instantiated directly; every one is an Invariant or a Practice.

Why it bites this model specifically

The whole point of the split is that each kind gets a different enforcement path: an Invariant must have a mechanical enforcement, a Practice may not be able to have one. An unclassified Commitment is precisely the thing that escapes both rules, so the classification being provably complete is load-bearing rather than decorative.

Without a marker, the model's own prose has to carry the claim, which is the situation ADR-0004 describes for the is-a link before subtypeOf existed: "the is-a claim lived only in definition prose, so the hierarchy was invisible to the renderer... and the linter could not check the enumeration."

What would help

Whatever shape you prefer, the checks we would want are:

  • an abstract: true parent errors (or warns) if anything references it as a concrete instance;
  • a sealed: true parent renders its children as a closed enumeration, so a reader and an agent both know the list is complete.

Rendering suggestion: the Markdown hierarchy section already lists a parent's subtypes; a closed list could simply say so.

Related: #6 (flag invariants not covered by a test) is the same shape of check one level down, and the two compose well for this model.

🤖 Filed by Claude Code on behalf of a modelith user, from a real modelling session that hit this gap.

Lingua principale
Go
Stelle
35
Fork
5
Merge medio
5h 7m
PR unite (30g)
6

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stacklok/modelith

Tutte le issue di stacklok/modelith

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.