公开贡献指南
Seed 欢迎围绕 AI Coding 协作结构的贡献:更清楚的文档、更实用的示例 Pack、更稳的检查脚本、更容易复用的项目规范。
公开贡献优先通过 https://github.com/mawflow/mawflow-seed 提交;国内访问可使用只读同步入口 https://gitee.com/mawflow/mawflow-seed。
本页是可选的贡献者指南,不是使用 MAWflow Seed 的必经步骤。公开贡献只接收已经脱敏、可复现、边界清楚的通用内容,不接收客户项目资料、内部任务记录、私有环境配置或平台运行时代码。
适合贡献什么
| 类型 | 示例 |
|---|---|
| 文档 | 快速开始、Prompt Spec 示例、模块档案示例、公开边界说明。 |
| 示例 Pack | Prompt Pack、Task Pack、Check Pack、Verification Pack。 |
| 检查脚本 | 只读检查、格式检查、脱敏检查、公开前 gate。 |
| 规范改进 | .maw 配置字段、模块档案字段、收口格式建议。 |
| 用例 | 个人项目、小团队项目、开源项目的使用流程。 |
贡献前自查
- 是否只使用公开仓库地址。
- 是否只使用仓库相对路径。
- 是否没有客户数据、内部任务、私有 URL、真实密钥或未脱敏日志。
- 是否提供最小示例和验证方式。
- 是否说明适用对象和不适用场景。
提交流程
- Fork 或 clone 公开仓库。
- 新建分支。
- 修改文档、示例或脚本。
- 运行相关检查。
- 提交 Pull Request,说明变更目的、验证结果和公开边界。
PR 描述建议
md
## 变更
- 新增 Task Pack 示例。
- 补充 Prompt Spec 验收字段说明。
## 验证
- git diff --check
- bash ops/scripts/check-local-boundary.sh
## 公开边界
- 未包含客户数据。
- 未包含私有仓库地址。
- 示例使用占位路径。维护原则
- 不把一次性项目事实写成通用规则。
- 不把私有环境能力写成 Seed 已开源能力。
- 不为了示例完整而加入不可公开资料。
- 不提交真实密钥、本机覆盖和未脱敏输出。
下一步
如果你想贡献一个示例,先阅读 公开示例脱敏检查。
