Clarify active satisfies and fulfils relations in metamodel comments

Offen Anfängerfreundlich
#1,019 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
88/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
yaml
Bereich
documentation

Rechercherichtung

Überprüfe die Kommentare oberhalb von satisfies und fulfils in src/extensions/score_metamodel/metamodel.yaml anhand der aktuellen Tool-Anforderungen und zulässigen Beziehungen. Beginne mit den im Issue genannten Beispielen zu tool_req und gd_req sowie Architekturelementen und berücksichtige außerdem Issue #972 zum Umfang von gd_req.satisfies. Aktualisiere die Kommentare, damit sie ihren aktuellen Zweck erläutern, und bewahre dabei Link-Deklarationen und Validierungsverhalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

intentionally-limited

The comments above satisfies and fulfils in src/extensions/score_metamodel/metamodel.yaml describe these relations as retained for backward compatibility. That suggests they can be deleted during cleanup, although the current metamodel actively allows and validates them.

For example, tool_req and gd_req use satisfies, and architecture elements use fulfils. Issue #972 explicitly tracks stronger enforcement of gd_req.satisfies.

Acceptance criteria:

  • Review the compatibility comments against the current tool requirements and permitted relations.
  • Replace stale comments with an explanation of the relations' current purpose and scope.
  • Preserve the existing link declarations and validation behavior; do not globally remove or rename satisfies or fulfils based on these comments.

This is a focused comment/documentation cleanup, not a breaking behavior change. Related to the broader cleanup request #969. The mod type and its migration are outside this issue's scope.

Vorherrschende Sprache
Python
Sterne
11
Forks
39
Ø Merge
1 T. 12 Std.
Gemergte PRs (30 T.)
47

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Hat eine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

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 eclipse-score/docs-as-code

Alle Issues in eclipse-score/docs-as-code

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

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