# 代码审查跨 GitHub PR、GitLab MR 和 Gerrit 更改协调代码审查。从 git 远程配置自动检测平台，并提供有关安全性、可维护性和架构适合度的集中审查反馈。这是一项**工作流程技能** \-- 它不包含脚本，而是使用适当的平台技能指导代理完成多步骤审核过程。 ## 身份验证该技能将身份验证委托给底层平台技能： * **GitHub** ：需要`gh auth login`（参见github技能） * **GitLab** ：需要`glab auth login`（参见gitlab技能） * **Gerrit** ：需要 `git-review` 配置（参见 gerrit 技能）在使用代码审查之前，确保相关平台技能经过验证。 ## 命令 ###回顾按号码或 URL 查看更改。 **用途：** 回顾公关 #123 查看此 MR：https://gitlab.com/org/repo/-/merge_requests/42 查看 Gerrit 更改 456789 该代理遵循工作流程步骤：从 git 远程或提供的 URL 检测平台，获取更改元数据、CI 状态和差异，然后提供结构化审核反馈。可以选择发表评论意见。 ###记住保存当前存储库评论的附加上下文。这保留了在未来审查同一存储库时应考虑的信息。 **用途：** 请记住，此存储库遵循 Google Python 风格指南请记住：身份验证更改必须由安全团队审核记住 https://internal-docs.example.com/api-conventions 作为 API 设计的参考请记住，数据层使用存储库模式，而不是 Active Record **关键字**：消息开头的单词**记住**会触发保存。上下文存储在当前存储库的远程 URL 下的 `~/.config/agent-skills/code-review.yaml` 中。 **要保存什么**：编码标准、架构决策、外部文档链接、团队约定、审核策略或任何应为未来审核提供信息的上下文。 ###忘记了删除当前存储库之前保存的上下文。 **用途：** 忘记关于 Google Python 风格指南的注释忘记此存储库的所有已保存上下文 ### 显示上下文显示当前存储库的所有已保存上下文。 **用途：** 显示此存储库的审核上下文 ###检查验证所需的平台技能是否可用且经过身份验证。 # 对于 GitHub 存储库技能/github/scripts/github.py 检查 # 对于 GitLab 存储库技能/gitlab/scripts/gitlab.py 检查 # 对于 Gerrit 存储库技能/gerrit/scripts/gerrit.py 检查 ## 存储库上下文每个存储库的上下文都保存在 `~/.config/agent-skills/code-review.yaml` 中，由来自 `git remote get-url origin` 的远程获取 URL 键入。此上下文在每次审核开始时加载（请参阅工作流程中的步骤 0）。 # ~/.config/agent-skills/code-review.yaml 存储库： “git@github.com:myorg/myrepo.git”：参考文献： -“https://internal-docs.example.com/api-conventions” -“https://google.github.io/styleguide/pyguide.html” 标准： - “所有 API 端点必须使用 Pydantic 模型验证输入” - “身份验证更改需要安全团队审核” 注释： -“数据层使用存储库模式，而不是活动记录” - “src/compat/ 中的旧模块不受新样式规则的约束” “https://gitlab.com/myorg/other-repo.git”：参考文献： -“https://docs.example.com/other-repo/architecture” 标准：[] 注释： -“从 REST 迁移到 GraphQL——新端点应使用 GraphQL” 当用户在审阅期间提供存储库外上下文时，建议使用 **remember** 命令来保留它。 ## 工作流程 ### 步骤 0：加载存储库上下文在开始审核之前，请检查已保存的上下文： git 远程获取 url 来源阅读 `~/.config/agent-skills/code-review.yaml` 并查找远程 URL。如果上下文存在，则加载它并在整个审核过程中牢记它： * **参考文献**：在评估架构决策时参考这些内容 * **标准** ：主动检查每个标准的遵守情况 * **注释**：将这些纳入审核反馈如果不存在上下文文件或存储库没有条目，则无需附加上下文即可继续。 ### 第 1 步：检测平台从存储库上下文确定代码托管平台： # 检查 git 远程 git 远程-v * 如果远程包含 `github.com` -> 使用 **github** 技能 * 如果远程包含 `gitlab` -> 使用 **gitlab** 技能 * 如果 `.gitreview` 文件存在 -> 使用 **gerrit** 技能 * 如果提供了 URL，则从 URL 主机名中检测 ### 步骤 2：获取更改元数据和 CI 状态 **GitHub：** Skills/github/scripts/github.py prs view --repo OWNER/REPO Skills/github/scripts/github.py prs 检查 --repo OWNER/REPO **亚搏体育app实验室：** Skills/gitlab/scripts/gitlab.py mrs view --repo GROUP/REPO Skills/gitlab/scripts/gitlab.py 管道列表 --repo GROUP/REPO **格里特：** Skills/gerrit/scripts/gerrit.py 更改视图 ### 步骤 3：评估 CI/测试状态在审核之前，检查 CI/测试是否已通过： * 如果 CI **通过**：继续进行全面审查 * 如果 CI **失败**：记下失败，跳过审查测试会捕获的问题，并关注测试无法捕获的问题（安全、架构、设计） * 如果 CI **待处理**：记下并继续审核 ### 步骤 4：获取差异 **GitHub：** gh pr diff <数字> **亚搏体育app实验室：** glab mr diff <数字> **格里特：** git diff HEAD~1 ### 第 5 步：查看更改按优先顺序重点关注这些领域的审核反馈。有关完整清单，请参阅 [references/review-checklist.md]()。 1. **安全问题**：注入漏洞、身份验证/授权差距、数据暴露、不安全的反序列化、硬编码秘密 2. **可维护性**：过于复杂、命名不当、关注点分离缺失、代码重复损害可读性 3. **良好的编码实践**：错误处理差距、资源泄漏、竞争条件、系统边界缺少输入验证 4. **架构适合**：与现有代码库模式的一致性、适当的抽象级别、依赖方向 **不要标记：** * 样式/格式问题（留给 linter） * 较小的命名偏好，没有明显的可读性影响 * 测试覆盖率差距（留给 CI 覆盖率工具） * 失败的 CI 已经发现了问题 ### 第 6 步：展示调查结果将调查结果格式化为结构化审查： ## 代码审查：PR #<编号> - <标题> ### 总结 <1-2句话变更总结及总体评估> ### CI 状态 <通过/失败/待定——记录任何失败> ### 调查结果 #### 安全 - [ ] <通过文件查找：行参考> #### 可维护性 - [ ] <通过文件查找：行参考> #### 编码实践 - [ ] <通过文件查找：行参考> #### 架构 - [ ] <通过文件查找：行参考> ### 判决 <批准/请求更改/评论——带有简短的理由> 如果用户请求，请使用平台技能将评论作为 PR/MR 的评论发布： **GitHub：** gh pr 评论 <编号> --comment --body "<评论>" # 或批准/请求更改： gh pr 审查 <编号> --approve --body "<审查>" gh pr 评论 <编号> --request-changes --body "<评论>" **亚搏体育app实验室：** glab mr note <编号> --message "<评论>" # 或批准：批准先生 ## 示例 ### 查看 GitHub PR 回顾公关 #42 代理将运行“git Remote -v”，检测 GitHub，使用“skills/github/scripts/github.py prs view 42”获取 PR，使用“skills/github/scripts/github.py prs Checks 42”检查 CI，使用“gh pr diff 42”获取差异，并提供结构化审核反馈。 ### 通过 URL 查看 GitLab MR 查看 https://gitlab.com/myorg/myrepo/-/merge_requests/15 ### 评论并发表评论查看 PR #42 并将您的发现作为评论发表 ### 审核仅关注安全性查看 PR #42，仅关注安全问题 ### 保存上下文以供将来评论请记住，此存储库使用十二因素应用程序方法记住 https://wiki.example.com/team/coding-standards 作为参考请记住：所有数据库迁移都必须向后兼容 ### 显示保存的上下文显示此存储库的审核上下文 ## 模型指导该技能协调多个子技能，并且需要对多步骤工作流程进行推理。建议使用更高功能的模型以获得最佳结果。 ## 故障排除 ### 未检测到平台确保您从配置了远程的 git 存储库中运行： git 远程-v ### 身份验证错误验证底层平台技能是否已通过身份验证： # GitHub gh 身份验证状态 # 亚搏体育app 明确的身份验证状态 ### 没有可用的差异确保 PR/MR 编号正确且更改存在： # GitHub Skills/github/scripts/github.py prs 视图 # 亚搏体育app Skills/gitlab/scripts/gitlab.py mrs 查看

代码审查

包含技能