Skip to main content
代码库规则使用与 IDE 规则文件检测相同的自动同步机制。在设置中启用”从代码库自动同步规则”以激活这两个功能。请参阅规则文件检测进行设置。

如何使用

您可以通过将结构化的 markdown 文件放置在特定目录中,直接在代码库中创建自定义 Kody 规则。这允许您对规则进行版本控制并与团队共享。

同步

  • 自动检测:启用后自动检测和同步代码库规则
  • 手动同步:在任何规则文件中添加 @kody-sync 以单独同步(即使禁用自动同步也有效)
  • Web 应用程序:同步的规则显示在您的 Kodus web 应用程序仪表板中
  • 实时更新:当拉取请求关闭时同步规则文件的更改

文件位置

将您的规则文件放在以下目录之一:
  • .kody/rules/**/*.md
  • rules/**/*.md

规则模板

每个规则文件必须遵循此确切的模板结构:

模板字段

必需字段

示例规则

文件级规则示例

拉取请求级规则示例

设置要求

要使用代码库规则,您有两个选项:

选项 1:启用自动同步(推荐)

  1. 启用规则文件检测:在设置中切换”从代码库自动同步规则”
  2. 创建规则文件:将 .md 文件放在 .kody/rules/**rules/** 目录中
  3. 自动同步:当 PR 关闭时所有规则文件同步

选项 2:手动同步(选择性)

  1. 创建规则文件:将 .md 文件放在 .kody/rules/**rules/** 目录中
  2. 添加同步标记:在规则文件中的任何位置包含 @kody-sync
  3. 提交更改:仅标记的文件将同步(自动同步切换保持关闭)
代码库规则使用与规则文件检测相同的同步机制。使用手动同步(@kody-sync)可以选择性地同步特定规则,而无需启用自动同步。