.coderabbit.yaml

language: zh-CN

# CodeRabbit configuration for boss-skill
# Focus on Shell scripts under scripts/, ignore documentation/templates.

summary:
  enabled: true
  instructions: |
    请使用简体中文为本次 Pull Request 生成总结，严格按照以下结构输出：

    1. 高层概览（Why）
       - 用 1–2 句话说明本次改动的背景与目的：为什么要做这些改动、希望解决什么问题或带来什么收益。

    2. 具体逻辑变更（What）
       - 使用无序列表（- 开头）逐条列出主要逻辑调整，每条建议包含：
         - 受影响的模块或脚本（如具体文件或功能名称）；
         - 变更类型（新增、重构、修复缺陷、配置调整等）；
         - 对行为、数据流或接口的关键影响。

    3. 潜在副作用与评审关注点（Risk）
       - 列出可能的副作用、风险点或需要 reviewer 特别留意的事项，例如：
         - 向后兼容性风险（是否可能影响现有调用或旧版本行为）；
         - 性能、资源占用或稳定性方面的变化；
         - 部署、回滚、运维操作或脚本执行顺序上的特殊注意事项。

    请保持总结简洁清晰，避免逐行复述 diff，更侧重于行为变化、设计意图与风险洞察，以便 reviewer 快速理解本次改动的核心价值与影响范围。

reviews:
  pull_requests:
    enabled: true
    drafts: true
    base_branches:
      - main

  # Limit review scope to Shell scripts and ignore docs/templates.
  path_filters:
    include:
      - "scripts/**/*.sh"
      - "scripts/*.sh"
    exclude:
      - "templates/**"
      - "agents/**"
      - "references/**"
      - "**/*.md"

  # High-level instructions to bias the AI review.
  review_instructions: |
    请使用简体中文（zh-CN）进行代码审查和评论。

    项目说明：
    - 本仓库以 Shell 脚本（scripts 目录）为核心，用于自动化适配与项目初始化等流程。

    审查重点（请优先关注以下内容）：
    1. Shell 脚本逻辑正确性
       - 命令执行顺序是否合理，是否存在早返回或遗漏分支。
       - 变量是否正确初始化与引用，是否有未定义变量的使用（特别是 set -u / set -e 场景）。
       - 条件判断（[ / [[ / test）语法是否正确，字符串与数字比较是否区分清楚。

    2. 边界条件与错误处理
       - 对关键命令的返回值是否进行了检查（例如：命令失败时是否中止或给出清晰提示）。
       - 是否处理了空输入、空文件、目录不存在、权限不足等异常情况。
       - 是否对外部依赖（git、curl、docker 等）的缺失做了友好校验与提示。

    3. 可移植性与健壮性
       - 是否依赖特定 Shell 特性（bash vs. sh），脚本 shebang 是否与语法一致。
       - 是否正确使用引号避免单词拆分与通配符误匹配（尤其在包含空格或特殊字符路径时）。
       - 路径拼接、临时文件处理是否安全，是否会误删或覆盖重要文件。

    4. 安全性
       - 是否避免使用不安全的 eval 或从不可信输入构造命令。
       - 是否对可能包含用户输入的变量做了适当转义。

    5. 可读性与可维护性（在不影响以上核心问题的前提下）
       - 适当的注释是否能帮助理解关键逻辑和约定。
       - 函数与脚本的职责是否清晰，是否便于后续扩展。

    忽略项（如无明显问题请少做评论）：
    - Markdown 文档（*.md）、说明类模板（templates/**、agents/**、references/**）中的文字表述与格式。
    - 与 Shell 逻辑无关的轻微样式或排版问题。

    总体目标：
    - 帮助作者识别 Shell 脚本中的逻辑缺陷、隐藏的边界条件问题以及潜在的安全风险；
    - 给出具体、可执行的修改建议，并尽量使用简洁清晰的中文说明原因和改进思路。