Skip to main content

概述

为新团队启动 Kodus 大约需要 30 分钟。本指南介绍完整设置,使您的团队从第一个 PR 开始就能获得价值。

步骤 1 — 创建和配置工作区

  1. kodus.io 注册或访问自托管实例
  2. 为团队创建新工作区
  3. 连接 Git 提供商(GitHub、GitLab、Bitbucket 或 Azure DevOps)
  4. 选择要监控的代码库

步骤 2 — 设置审查基线

在自定义之前从合理的默认值开始:
这为您提供合理建议限制的自动审查。根据反馈在一周后调整。

步骤 3 — 从 IDE 工具导入现有规则

如果团队已经使用 Cursor、Copilot 或 Claude 规则:
  1. 前往代码审查设置Kody 规则
  2. Kodus 检测 .cursorrules.github/copilot-instructions.md.claude 文件
  3. 导入对代码审查有意义的规则
这避免了从头重写规则。

步骤 4 — 教授前 5 个约定

不要试图在第一天就编码所有内容。从团队争论最多的 5 个约定开始:
这些成为立即应用于所有审查的记忆。

步骤 5 — 创建 2-3 个关键规则

添加绝对不能发生的事情的规则:

步骤 6 — 连接任务管理(可选但推荐)

设置插件中连接 Jira、Linear、Notion 或 ClickUp 以启用业务逻辑验证。这让 Kodus 检查 PR 是否实现了任务描述的内容。

步骤 7 — 运行试点 PR

打开一个测试 PR 并验证:
  • Kodus 评论出现在 PR 上
  • 建议相关且严重性适当
  • 自定义规则在应该触发时触发
  • 记忆反映在审查上下文中

步骤 8 — 一周后收集反馈

一周审查后,与团队确认:
  • 建议太多?→ 提高 severityLevelFilter 或降低 maxSuggestions
  • 规则太嘈杂?→ 缩小文件路径或添加排除
  • 遗漏重要模式?→ 添加新规则或记忆
  • 想要自动生成规则?→ 点击生成 Kody 规则从审查历史中获取建议

提示

  • 第一天不要过度添加规则 — 从小处开始逐步增长
  • 让团队在正式化为规则之前通过对话自然地教 Kody
  • 前几个 PR 使用 @kody start-review 让团队看到 Kodus 的实际效果
  • 如果想审查 Kody 学到的内容,启用 LLM 生成记忆审批
完整设置指南,请参阅快速开始