跳转至

贡献指南

谢谢你愿意改这本手册。这个仓库是文档项目,最有价值的贡献通常是纠错、补链接、补真实案例,或者把一段读起来绕的说明改清楚。

可以提交什么

  • 修正错别字、坏链、格式问题。
  • 补充工具、框架、命令或参考资料的准确信息。
  • 补真实使用经验,但要写清楚适用场景和限制。
  • 调整章节结构,让读者更容易沿着主线读下去。
  • 改写标题和导读,让它们更直接,但不要改丢技术含义。

大范围结构调整建议先开 issue。小修可以直接提 pull request。

写作口径

  • 标题先说清本节处理什么问题,不用“全面解析”“终极指南”这类词。
  • 保留必要术语,例如 Prompt Engineering、Context Engineering、Harness Engineering、MCP、skills。
  • 少写空泛判断,多写可验证的事实、边界和操作步骤。
  • 新增工具或项目时,优先链接官方文档、官方仓库或可信的公开仓库;找不到可靠链接就不要硬补。
  • 命令、路径、文件名和版本信息要能核对。不能确认时,在正文里说明不确定性。

提交前自查

在仓库根目录运行:

git diff --check

同时检查这些点:

  • Markdown 相对链接能打开。
  • 新增内容没有泄露 token、账号、私人邮箱或内部路径。
  • 新增外部链接不是广告页、聚合页或可疑跳转。
  • 没有提交生成目录、部署副本或和本次修改无关的文件。
  • 如果使用 AI 辅助写作,最终内容已经人工核对过。

Pull Request 流程

  1. Fork 仓库,基于最新主分支创建分支。
  2. 保持改动聚焦:一个 PR 处理一个主题。
  3. 在 PR 说明里写清楚改了哪些章节、为什么改。
  4. 勾选 PR 模板里的自查项。
  5. 等待维护者 review。维护者可能会要求缩小范围、补来源或改写语气。

许可证

提交贡献即表示你同意将贡献内容按本仓库的 CC BY 4.0 许可证发布。第三方项目名称、商标、截图和外部资料仍遵守各自的许可和使用条款。