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

Check a hand-written architecture model against the map, with evidence and without verdicts

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

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Start with the proposed dircue map check-model --model likec4.json map.json entry point and compare its intended JSON and Markdown output with map compare. Read the shared element-mapping dependency in issue #152 and the runtime-relationship limitation in #103. Done means deterministic, evidence-backed model and map comparisons with neutral wording, unknown kept distinct from absent, and no policy or severity verdicts.

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

Descrizione

enhancement

User outcome

A team that keeps a hand-written architecture model can ask dircue which parts of that model the repository's declarations support, and which declared parts the model doesn't mention. Both answers come as facts with evidence, deterministically, without an AI step:

dircue map check-model --model likec4.json map.json

Why

  • Hand-written models (C4 via LikeC4 or Structurizr, Backstage catalogs) drift. Tools are appearing to detect that drift, but they use models to judge code changes and emit severity-ranked findings. erode, for example, reads a LikeC4/Structurizr model and uses AI to analyze pull requests.
  • A deterministic, evidence-first check is the missing complement. It doesn't judge whether a dependency is allowed. It reports, per element and relationship, whether the map observed it and where, and it reports what the map observed that the model lacks.

Proposal

  • Inputs:
    • a saved map;
    • a model the team exported with its own tool. Start with LikeC4's likec4 export json, then Structurizr workspace JSON and Backstage entities. dircue reads these files; it never runs the modeling tool.
    • an explicit, user-written mapping from model element IDs to map selectors (paths, component names, deployable IDs), with a conservative default matcher (exact names and paths only).
  • Output (JSON and Markdown, like map compare):
    • model elements and relationships with map evidence, without map evidence, or not decidable (the relevant map question is partial or unknown, or the relation kind isn't observed, as with runtime calls until #103);
    • map components, deployables and capabilities (primary role) absent from the model.
  • Neutral wording. "Not observed in the declarations of this revision", never "violation", "risk" or a severity. Unknown is never reported as absent.
  • CI use: pairs with the map compare action (#10) to show model-relevant changes in a pull request.

Non-goals

Dependencies

Lingua principale
Go
Stelle
0
Fork
0
Merge medio
5h 8m
PR unite (30g)
54

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 war-and-code/dircue

Tutte le issue di war-and-code/dircue

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.