Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

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

Offen
  • Stimmt etwas nicht?
#24 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
45/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
go
Bereich
tooling

Rechercherichtung

Beginne mit ADR-0004 und der bestehenden subtypeOf-Implementierung, um das Schema und die Konventionen für die Validierung zu verstehen. Verfolge dann den im Issue beschriebenen Abschnitt zur Markdown-Hierarchie und die zugehörigen Prüfungen. Die Aufgabe ist abgeschlossen, wenn abstrakte Eltern nicht als konkrete Instanzen verwendet werden können und versiegelte Eltern ihre Subtypen als geschlossene Aufzählung darstellen, mit Tests für beide Marker.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Go
Sterne
35
Forks
5
Ø Merge
5 Std. 7 Min.
Gemergte PRs (30 T.)
6

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus stacklok/modelith

Alle Issues in stacklok/modelith

Ähnliche Issues

Weitere Issues zu Go

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.