allium skills: document invariant+@guidance pattern for complex semantics

Aperta Adatta ai principianti
#8 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
65/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Ambito
documentation

Direzione di ricerca

Inizia esaminando le skill allium esistenti, in particolare allium:tend, e il contesto sorgente del wemble issue #109. Documenta quando usare regole formali invece del pattern invariant più @guidance, includendo l'elaborazione delle collection e la concorrenza in più fasi; il lavoro è completato quando il pattern e i relativi criteri decisionali sono chiari per gli autori delle spec.

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

Descrizione

Context

When Allium behaviors are too complex to express as trigger/ensures rules (e.g., concurrent iteration, parallel merge, heterogeneous collection processing), there's a useful workaround pattern that isn't documented in the allium skills.

Pattern

Use invariant Name { true } with an @guidance block for prose:

invariant ParallelMerge { true }
@guidance """
All parallel branches execute concurrently.
Results are merged into the parent entity when all branches complete.
"""

The checker accepts this; the meaningful content lives in the guidance annotation.

Request

Document this pattern in the allium skills (likely allium:tend or a new "Spec Authoring Patterns" section) explaining:

  • When to use formal rules vs invariant+@guidance
  • Reserve formal rules for entity state transitions and attribute causality
  • Use invariants+@guidance for behaviors involving collection processing or multi-phase concurrency

Source

Discovered during wemble issue #109 — parallel/iterate/cond semantics couldn't be expressed cleanly with Allium rule syntax.

Lingua principale
JavaScript
Stelle
10
Fork
6
Merge medio
9m
PR unite (30g)
1

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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.

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.