感谢您有兴趣为 AI 应用协议(AIAP)做出贡献!本文档提供贡献指南。
⚠️ 当前阶段的贡献政策我们欢迎通过 GitHub Issues 进行讨论。
当前不接受外部 Pull Request。 如果您有任何建议 — bug 报告、功能想法、规范澄清或质量规则建议 — 请通过 Issue 描述。如果我们认为有价值,由维护者实现并在 commit/release notes 中署名感谢您。
此政策未来会重新审视。
阶段状态(v1.0.0)
AIAP 处于早期规范阶段。下方流程描述的是目标治理模型。初期决策由 AIXP Labs 核心维护者做出;社区讨论窗口将随贡献者基数增长而扩大。
- 使用 GitHub Issues 报告 bug、提议功能或建议规范变更
- 规范变更请使用
spec-changeissue 模板 - 提供清晰描述,尽可能附带示例
请勿直接提交 PR,而是:
- 打开 Issue,描述您的提议、Bug 或想法
- 与维护者讨论 — 明确范围、设计和方法
- 等待审核 — 重要提议遵循下方规范变更流程
- 若被采纳,维护者将实现该变更并在 commit/release notes 中署名感谢您
影响规范性内容(specification/ 中任何文件)的提议遵循以下流程:
- 带
spec-change标签的 Issue,描述提议变更 - 非平凡变更需要至少 14 天的讨论期(目标治理模型;当前讨论窗口随贡献者基数调整)
- 重大决策需要在
adrs/中记录架构决策记录(ADR) - 维护者进行 Axiom 0 合规审查
- 同步更新反映变更的文档
非规范性内容(topics、guides、reference)的建议通过 Issue 提交即可 — 错别字修正、澄清、补充示例尤其受欢迎。维护者将实现被采纳的建议。
撰写规范性内容时,请使用 RFC 2119 定义的关键词:
- MUST / MUST NOT — 绝对要求
- SHOULD / SHOULD NOT — 强烈建议(允许有据可循的例外)
- MAY — 真正可选
这些关键词在规范意义上必须大写。
- 使用 "AIAP 程序"(不要用 "AIAP agent" 或 "AIAP application")指代受治理的软件
- 使用 "AISOP 文件" 指代单个
.aisop.json文件 - "Axiom 0" 大写(专有名词)
- Pattern 名称首字母大写:"Pattern A"、"Pattern G"
- 信任等级写作 "T1"、"T2"、"T3"、"T4"
- 每个主题文档以一段简介开头
- 字段规范用表格
- 示例代码块标注语言
- 流程与架构示意用 Mermaid 图
- 文档之间用相对链接互相引用
所有规范文档必须以下行结尾:
Align Axiom 0: Human Sovereignty and Wellbeing. Version: AIAP V1.0.0. www.aiap.dev
所有贡献者必须遵守 行为准则。Axiom 0 承诺适用于所有贡献。
提交 Issue 或任何其他内容(包括规范建议、Issue 中的代码片段或设计建议)即表示您同意维护者可以在 Apache License 2.0 条款下使用您提交的内容,与本项目使用相同的许可证。
Align Axiom 0: Human Sovereignty and Wellbeing. Version: AIAP V1.0.0. www.aiap.dev