记得关注我们哦!
代码审查耗时太长,拖慢项目进度? 审查质量参差不齐,一些关键问题被遗漏? 复杂代码变更看不懂,审查者需要大量时间理解意图?
产品核心优势:
✅ 提高质量:提供精准反馈,帮助代码质量再上新台阶。
✅ 提升效率:自动总结 MR,让审查者一眼看懂变更意图。
✅ 智能评分:多维度评估代码,确保达到最佳标准。
Starship现已上架GitHub Marketplace,通过以下步骤,您可以快速安装并配置 Starship App,并开始使用其代码审核功能。
1. 安装 Starship App
访问应用主页
打开 OpenCSG-Starship 应用主页(https://github.com/marketplace/opencsg-starship)。安装应用
点击主页下方的“安装”按钮,开始安装 Starship App。配置 GitHub 仓库安装完成后,前往 Starship 配置平台(https://starship.opencsg.com/),对已安装的 GitHub 仓库进行代码审核配置。
2. 同步 GitHub 权限
登录 Starship 配置平台
访问 starship.opencsg.com 并登录。同步 GitHub 权限
在 Settings(设置) 页面,点击 “同步 GitHub 权限” 按钮:完成账号绑定
点击按钮后,您的 GitHub 账号将与当前 Starship 登录用户绑定。
3. 添加 GitHub 项目
点击添加项目
在配置平台中,点击 “添加项目” 按钮:授权安装 OpenCSG-Starship App
系统将打开 GitHub 的授权安装界面,您可以选择在哪个 GitHub Organization 中安装 Starship App:选择仓库范围
选择一个 Organization 后,您可以决定授权所有仓库或部分仓库:等待同步完成
安装完成后,系统将自动同步已安装 App 的项目,并同步用户的管理权限。此过程可能需要 1-5 分钟 初始化时间。成功后,您将在 设置 页面看到已连接的仓库列表:
4. 配置项目的 Code Review 规则
进入项目设置
在 设置 界面,选择已连接的仓库。
开始 Code Review 配置
当前版本的 Starship App 专注于代码审核功能,您可以根据需要定制项目的审核规则:注意事项
初始化时间:安装 App 并同步项目后,初始化可能需要 1-5 分钟。请耐心等待。 功能范围:目前,Starship GitHub App 仅支持代码审核功能,更多功能正在开发中。 通过以上简单步骤,您即可开始使用 OpenCSG-Starship App 进行高效的代码审核管理!
核心功能介绍
1️⃣ 审查MR
审查结果
接受(LGTM): 表示代码已经达到了设定的所有质量和安全基准,看起来没有需要进一步改进的重大问题,可以合并。 待提升: 与LGTM相反,这个结果表示代码虽然可能是可运行的,但可能没有达到特定的质量、性能或安全标准等。
审查评论和建议
重点评论和建议: 对于直接与特定代码行相关的问题, StarShip CodeReviewer
会直接在相关代码行后追加讨论。这种反馈模式确保开发者可以看到每个评论或建议的确切上下文。一般性审查评论和建议: 并非所有反馈都与特定代码行相关,一些建议可能与代码库的更广泛方面或编程实践有关。对于这类情况, StarShip CodeReviewer
将反馈在“其他审查评论和建议”部分。
配置自定义指令
项目级配置: 可以通过DB(数据库)配置页面轻松地在项目级别整合自定义指令。这种集中式方法允许用户或团队领导一次性指定独特的规则和指导方针,将其应用于项目内的所有合并请求。 合并请求级配置: 为了提高量身定制的审查体验,用户可以选择直接在合并请求的备注中指定自定义指令,这种指令可能是项目级配置可能覆盖不到的独特规则。
2️⃣ 总结MR
StarShip CodeReviwer的总结功能,通过自动生成简明扼要MR摘要,帮助人工审查者迅速理解代码变更的本质和意图,大大减少了审查和批准MR所需的时间。
自动生成描述:一旦自动触发,StarShip CodeReviwer立即分析MR的内容,并输出一个简明且全面的摘要,概括了MR的目标、变更和潜在的影响。这个摘要会无缝地直接并入MR描述中,确保审查者在深入详细审查之前,即可获得一个清晰的MR概览。
手动触发,灵活易用:
用户可以通过在MR评论中手动触发,默认情况下,生成的摘要内容会附加到MR Note上。
如果您想要此总结追加到MR描述(在MR最前端)中,可以通过如下方式来手动触发。
@codegpt /describe --config={"mode": "append"}
如果您想用此总结完全代替MR描述,可以通过如下方式来手动触发。请注意,这种情况下,用户原来在MR描述中的内容将被替换。
@codegpt /describe --config={"mode": "replace"}
请注意,在MR描述变更之后,可能需要手动刷新网页来查看最新内容。
3️⃣ 评价MR
4️⃣ 多语言代码静态分析
配置
触发多语言代码静态分析
@codegpt /linter
手动触发
触发MR审查: 在合并请求(MR)中添加如下评论,触发一个自动化的代码审查过程,分析代码变更,发现潜在的错误以及改进方案。 @codegpt /review
触发MR总结: 在合并请求(MR)中添加评论如下评论,这个命令启动一个自动化总结过程,帮助审查者快速理解MR。 @codegpt /describe
触发MR评估: 在合并请求(MR)中添加评论如下评论,触发对代码进行全面评估。这包括性能分析、安全漏洞检查和优化建议,确保代码变更既健壮又高效。 @codegpt /evaluate
触发MR全面审查: 如果您希望进行全方位分析,包括审查、描述和评估您的代码,只需在合并请求(MR)中添加评论如下评论。这个命令整合了前面命令的所有功能,一次性地对您的代码进行彻底的检查和评估。 @codegpt /all
访问帮助信息: 想要获得帮助或更多关于可用命令及其使用方法的信息,请在合并请求(MR)中添加评论如下评论。 @codegpt /help
在MR中触发这些功能,可以极大地简化代码审查过程,提高代码质量。
使用自定义配置的大型语言模型 (LLM)
@codegpt-custom /review
在默认和自定义 LLM 之间切换
@codegpt-gpt4 /review
🔗 StarShip现已上架GitHub,让你的代码审查更智能、更高效! 🚀
💬 立即安装,让开发更轻松!
欢迎加入OpenCSG社区
•贡献代码,与我们一同共建更好的OpenCSG
•Github主页
欢迎🌟:https:// github.com/OpenCSGs
•Huggingface主页
欢迎下载:https://huggingface.co/opencsg
•加入我们的用户交流群,分享经验
扫描上方二维码添加小助手
“ 关于OpenCSG