跳到主要内容

审查合并请求

该功能旨在完善和改进的代码质量,通过深入理解MR,仔细检查代码变更,支持代码变更中遇到的问题,可能包括微小的代码问题,也可能是关键漏洞等。

审查结果

审查结果分类:

该功能模块将其审查结果分为两种不同的类型:

  • 接受(LGTM): 表示代码已经达到了设定的所有质量和安全基准,看起来没有需要进一步改进的重大问题,可以合并。 Alt text

  • 待提升: 与LGTM相反,这个结果表示代码虽然可能是可运行的,但可能没有达到特定的质量、性能或安全标准等。 Alt text

审查评论和建议

  • 重点评论和建议: 对于直接与特定代码行相关的问题,StarShip CodeReviewer会直接在相关代码行后追加讨论。这种反馈模式确保开发者可以看到每个评论或建议的确切上下文。 Alt text

  • 一般性审查评论和建议: 并非所有反馈都与特定代码行相关,一些建议可能与代码库的更广泛方面或编程实践有关。对于这类情况,StarShip CodeReviewer将反馈在“其他审查评论和建议”部分。 Alt text

配置自定义指令

StarShip CodeReviewer提供了高度可定制和灵活的代码审查方法,允许用户定义针对特定规则或标准的自定义指令。这一特性确保了代码审查过程完美地与组织标准、项目特定需求或独特的编码实践相一致。

  • 项目级配置: 可以通过DB(数据库)配置页面轻松地在项目级别整合自定义指令。这种集中式方法允许用户或团队领导一次性指定独特的规则和指导方针,将其应用于项目内的所有合并请求。 Alt text
  • 合并请求级配置: 为了提高量身定制的审查体验,用户可以选择直接在合并请求的备注中指定自定义指令,这种指令可能是项目级配置可能覆盖不到的独特规则。 Alt text

通过允许指定自定义指令,StarShip CodeReviewer确保代码不仅符合一般质量标准,而且还遵守项目或组织的独特要求或编码规范。