cannbot-knowledge贡献指南：从提交知识Issue到PR合入的完整流程教程

cannbot-knowledge贡献指南从提交知识Issue到PR合入的完整流程教程【免费下载链接】cannbot-knowledgecannbot算子开发知识库插件依赖的知识库本体仓给cannbot提供统一的知识底座。项目地址: https://gitcode.com/cann/cannbot-knowledgecannbot-knowledge 是 CANN 社区的算子开发知识库为 CANNBot 提供统一的知识底座。这篇贡献指南教程带你走完完整流程从提交知识 Issue、生产 Markdown 知识卡到通过质量门禁提交 PR最终由 committer 检视合入7 个步骤即可上手。CANNBot知识库cannbot-knowledge仓库群结构示意图cannbot-knowledge作为知识库检索货架1️⃣ 三种贡献类型先选对路径动手前先判断你要做的是哪类贡献流程要求完全不同详见 CONTRIBUTING.md贡献类型流程评审重点 知识建设新增、补充、合并、拆分或废弃知识知识 Issue → 生产知识并验证效果 → 关联 PR → 合入缺口是否真实、证据是否充分 公共组件新增或优化检索 Skill、索引、摄入、校验等RFC → A/B test → 关联 PR → 合入方案是否必要、实验是否可复现 缺陷修复与轻量修订知识错误、脚本 bug、错别字直接提交 PR → 合入修复依据是否清楚、验证是否有效本文聚焦最常见的知识建设路径这也是大多数新手第一次贡献的入口。2️⃣ 准备环境安装 contributor 模式贡献者需要安装contributor模式它比查询模式多了knowledge-ingest、knowledge-lint等写入类 Skillgit clone --branch master https://gitcode.com/cann/cannbot-knowledge cd cannbot-knowledge bash install.sh claude /path/to/project contributor更多安装选项自定义位置、Python 环境、离线安装见 安装与使用指南。3️⃣ 第一步提交知识 Issue——缺什么、怎么产生、有什么效果写卡前先搜索同主题知识和已有 Issue再用知识需求表单提交 Issue核心回答三部分知识缺口谁在什么任务中遇到什么问题现有检索缺了什么当前影响是什么知识生产方案处理方式create / update / merge / split / deprecate / defer、候选来源官方文档、固定提交源码、可复核实验、生产方法与复核方式预期效果与验收贡献后能回答什么问题给出至少一个可复核的目标场景输入条件 预期结果。 增加若干张卡只说明工作量不能说明效果。未测量前收益要保留为预期不要写成已验证结论。4️⃣ 搜索已有知识决定处理方式用knowledge-query搜索同一主题明确本次是哪种操作操作含义create没有同主题卡新增一张update原卡职责不变补充或修正内容merge/split多卡重叠合并 / 一卡多责拆分deprecate结论仍可解释历史行为但不再推荐defer来源或验证不足暂不落库不建占位卡不要仅因标题不同就创建新卡也不要自动覆盖原卡。5️⃣ 编写知识卡路径、Frontmatter 与正文选择路径——知识正文只能进入knowledge/常规形态为knowledge/domain/technology-or-scope/profile/slug.md例如knowledge/ops/ascendc/apis/utils_api/cpp_stdlib/math_functions/ceil_division.mdops是领域ascendc是技术apis是路径 Profile文件名用稳定的小写snake_case。完整规则见 知识路径规范。填写 Frontmatter——所有非index.md卡片必须包含 8 个公共字段type、title、description、tags、status、sources、created_at、updated_at。type由路径 Profile 唯一决定不要自行创造类型。字段语义见 Frontmatter 与证据。编写正文——让读者不依赖来源原文也能判断结论覆盖 5 点核心结论或适用场景必要的机制、参数或操作步骤平台、版本、shape、dtype 等边界验证方式及证据强度与其他卡片的显式相对链接。⚠️ 两张红线一个 DSL 的经验不能直接写成另一个 DSL 的事实搜索摘要、聊天记录或模型记忆不能单独作为技术来源每张卡的sources必须能定位到支持结论的证据。6️⃣ 更新导航与日志跑通质量门禁写完卡不等于完成还要同步新增、删除或移动卡片时逐层更新受影响的index.md导航实质知识变更记录到当天logs/运行全库检查修复路径、字段、导航、链接、来源问题。提交前在仓库根目录执行统一质量门禁bash check.sh它执行知识 Lint、导航检查、索引与检索回归、单元测试与静态检查入口脚本见 check.sh。7️⃣ 验证效果提交关联 PR回到 Issue 中的验收场景验证保留原始问题、查询条件、贡献前的缺口、贡献后命中的卡片与正文依据确认新知识能被检索到、且不会出现在错误范围内。PR 正文按问题 → 方案 → 产物 → 证据组织三部分缺一不可关联与范围贡献类型、关联 Issue、实际改动文件交付与效果处理决定、来源、生产方法、验收场景及实际结果检查与评审重点执行的检查与结果、已同步的导航/日志、需要 committer 重点判断的风险。✅ committer 检视与合入条件committer 会核对Issue 中的缺口是否真正解决、来源与平台版本范围是否支撑结论、有无重复或过度泛化、目标场景效果是否可复核。合入前必须满足对应贡献类型的材料完整验收标准达成阻断性评审意见已解决当前版本的bash check.sh通过获得 committer 明确认可后由其执行合入并回填关联 Issue。这些贡献会被拒绝无可靠来源的性能或默认行为结论、大段复制上游文档、把单一技术经验过度泛化为 shared、把一个 DSL 的行为写成另一个 DSL 的事实、静默删除过时知识。按以上 7 步完成你的第一张知识卡你的工程经验就能被 CANNBot 和整个社区持续检索复用。完整操作清单见 贡献知识最佳实践设计取舍可延伸阅读 知识库设计原则。【免费下载链接】cannbot-knowledgecannbot算子开发知识库插件依赖的知识库本体仓给cannbot提供统一的知识底座。项目地址: https://gitcode.com/cann/cannbot-knowledge创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考