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

未关闭 适合新手
#8 1 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
65/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
冷清
领域
documentation

调研方向

首先审查现有的 allium skills,尤其是 allium:tend,以及来自 wemble issue #109 的源上下文。记录何时应使用 formal rules,而不是 invariant 加 @guidance 模式,包括 collection 处理和多阶段并发;当该模式及其决策标准对 spec authors 来说清晰明确时,即视为完成。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
JavaScript
星标
10
派生
6
平均合并
9 分钟
30 天内合并 PR
1

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。