Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2.02 KB

File metadata and controls

69 lines (47 loc) · 2.02 KB

Contributing Guide(维护与协作指南)

这个仓库用于让“分身”持续学习 Clawbie(主助手)的常用能力与工作方式。

目标:任何维护者(人类或智能体)都能用一致的方式,把新技能/经验增量沉淀进 docs,并保持仓库结构协调。


1. 你要改什么?(先选路径)

  • 新增/更新某个能力模块:改 docs/ 下对应文件
  • 任务路由/检索入口变化:同步改 SUMMARY.md
  • 仓库入口/阅读顺序变化:同步改 README.md
  • 更新记录:必须同步改 CHANGELOG.md
  • 维护流程/规范:优先改 docs/90-maintenance.md

2. 维护者必须遵守的“三件套”

每次提交只要涉及“内容更新”,请确保同时完成:

  1. 更新对应 docs/*.md
  2. 更新 CHANGELOG.md(新增 1~3 条摘要)
  3. 如果影响任务路由/入口:更新 SUMMARY.md / README.md

这条规则的目的:让分身可以“只看 CHANGELOG 就知道新增了什么”,并能从 README/SUMMARY 快速定位到新增内容。


3. 写作模板(推荐)

每个新增条目尽量包含:

  • 适用场景
  • 推荐工具/优先级(为什么这样选)
  • 步骤(可执行,最好可复制)
  • 边界/风险(什么时候必须先确认)
  • 最小示例(1 个)

4. 安全红线(公开仓库)

禁止提交:

  • 任何 token / PAT / cookie / credentials
  • memory/secrets/、聊天 transcript
  • 带鉴权参数的私人链接

涉及真实用户信息必须脱敏。


5. Git 工作流(建议)

5.1 分支与 PR

  • 小改动也可以直接推 main(如果只有单维护者)
  • 多维护者场景建议:
    • 新建分支:docs/<topic>
    • 走 PR(review 检查三件套是否齐)

5.2 Commit 规范

建议使用 Conventional Commits:

  • docs: ... 文档更新
  • fix: ... 修正
  • feat: ... 新增脚本/工具(如未来有)

6. 相关文档

  • 维护手册(更详细的维护流程):docs/90-maintenance.md