网站热区图,深圳住房和建设管理局官方网站,软件技术专升本考什么科目,室内设计效果图全景图在代码开发的日常中#xff0c;你是否常常被以下问题困扰#xff1f; 代码审查耗时太长#xff0c;拖慢项目进度#xff1f; 审查质量参差不齐#xff0c;一些关键问题被遗漏#xff1f; 复杂代码变更看不懂#xff0c;审查者需要大量时间理解意图#xff1f;
别担…在代码开发的日常中你是否常常被以下问题困扰 代码审查耗时太长拖慢项目进度 审查质量参差不齐一些关键问题被遗漏 复杂代码变更看不懂审查者需要大量时间理解意图
别担心StarShip CodeReviewer —— 由 OpenCSG 倾力打造的智能代码审查助手来帮你解决这些问题
为什么选择 StarShip CodeReviewer
StarShip CodeReviewer 是基于先进大语言模型LLM技术开发的代码审查工具旨在为开发团队提供 自动化、智能化、高效化 的代码审查体验。无论是 个人开发者 还是 大型研发团队StarShip CodeReviewer 都能助你一臂之力
产品核心优势
✅ 降低成本自动化代码审查减少人力投入。 ✅ 提高质量提供精准反馈帮助代码质量再上新台阶。 ✅ 提升效率自动总结 MR让审查者一眼看懂变更意图。 ✅ 智能评分多维度评估代码确保达到最佳标准。
Starship现已上架GitHub Marketplace通过以下步骤您可以快速安装并配置 Starship App并开始使用其代码审核功能。 StarShip Web 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
该功能旨在完善和改进的代码质量通过深入理解MR仔细检查代码变更支持代码变更中遇到的问题可能包括微小的代码问题也可能是关键漏洞等。
审查结果
该功能模块将其审查结果分为两种不同的类型 接受(LGTM): 表示代码已经达到了设定的所有质量和安全基准看起来没有需要进一步改进的重大问题可以合并。 待提升: 与LGTM相反这个结果表示代码虽然可能是可运行的但可能没有达到特定的质量、性能或安全标准等。
审查评论和建议 重点评论和建议: 对于直接与特定代码行相关的问题StarShip CodeReviewer会直接在相关代码行后追加讨论。这种反馈模式确保开发者可以看到每个评论或建议的确切上下文。 一般性审查评论和建议: 并非所有反馈都与特定代码行相关一些建议可能与代码库的更广泛方面或编程实践有关。对于这类情况StarShip CodeReviewer将反馈在“其他审查评论和建议”部分。
配置自定义指令
StarShip CodeReviewer提供了高度可定制和灵活的代码审查方法允许用户定义针对特定规则或标准的自定义指令。这一特性确保了代码审查过程完美地与组织标准、项目特定需求或独特的编码实践相一致。 项目级配置: 可以通过DB数据库配置页面轻松地在项目级别整合自定义指令。这种集中式方法允许用户或团队领导一次性指定独特的规则和指导方针将其应用于项目内的所有合并请求。 合并请求级配置: 为了提高量身定制的审查体验用户可以选择直接在合并请求的备注中指定自定义指令这种指令可能是项目级配置可能覆盖不到的独特规则。
通过允许指定自定义指令StarShip CodeReviewer确保代码不仅符合一般质量标准而且还遵守项目或组织的独特要求或编码规范。 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
评估功能是为了确保您的代码达到最高标准。通过从十大维度和几十个角度来评估代码变更StarShip CodeReviewer不仅根据LLM评估给出了一个综合分数还解释了背后的原因。 4️⃣ 多语言代码静态分析
配置
首先选择需要使用多语言代码静态分析的项目仓库点击编辑 确保需要进行多语言静态分析的项目打开检查工具 触发多语言代码静态分析
在合并请求MR中添加如下评论触发一个自动化的静态代码扫描过程分析代码变更发现潜在的错误以及改进方案。
codegpt /linter
有两种方式触发StarShip CodeReviewer:
自动出击新的合并请求一旦创建并含有代码变更StarShip CodeReviewer就会自动介入开始审查全程自动化省心省力。
手动召唤如果您想在特定时刻或对已提交的合并请求再次审查可用手动方式触发。在MR里增加一条codegpt开头的评论StarShip CodeReviewer立刻出动。
手动触发
除了创建MR时候自动触发外如果您想手触发StarShip CodeReviewer可以通过在您的合并请求MR中添加特定的评论来触发。 触发MR审查 在合并请求MR中添加如下评论触发一个自动化的代码审查过程分析代码变更发现潜在的错误以及改进方案。 codegpt /review 触发MR总结 在合并请求MR中添加评论如下评论这个命令启动一个自动化总结过程帮助审查者快速理解MR。 codegpt /describe 触发MR评估 在合并请求MR中添加评论如下评论触发对代码进行全面评估。这包括性能分析、安全漏洞检查和优化建议确保代码变更既健壮又高效。 codegpt /evaluate 触发MR全面审查 如果您希望进行全方位分析包括审查、描述和评估您的代码只需在合并请求MR中添加评论如下评论。这个命令整合了前面命令的所有功能一次性地对您的代码进行彻底的检查和评估。 codegpt /all 访问帮助信息 想要获得帮助或更多关于可用命令及其使用方法的信息请在合并请求MR中添加评论如下评论。 codegpt /help
在MR中触发这些功能可以极大地简化代码审查过程提高代码质量。
使用自定义配置的大型语言模型 (LLM)
StarShip CodeReviewer旨在提供多样化和全面的代码审查体验支持与 SaaS软件即服务大型语言模型如 GPT-4同时也支持自定义本地 LLM 服务例如deepseek-code-33B。研发团队可以从数据隐私等方面考虑选择最适合特定代码审查需求的 LLM 服务。
如果您已设置了一个自定义 LLM您可以通过在您的合并请求MR中添加格式为 codegpt-custom ...的评论来触发。
例如如果您配置了一个更好地适应项目特定要求或编码标准的自定义本地 LLM只需使用如下命令来触发它
codegpt-custom /review
这个命令将使用您的自定义配置的 LLM 启动代码审查过程提供独特的见解和建议。
在默认和自定义 LLM 之间切换
如果您将自定义本地 LLM 设置为默认模型但偶尔需要利用另一个模型如 GPT-4StarShip CodeReviewer支持轻松地为特定任务切换。在MR中在评论中添加 codegpt-gpt4 ...这使得StarShip CodeReviewer暂时利用 GPT-4 模型完成审查。
例如如果您希望使用 GPT-4 模型进行代码审查您将输入
codegpt-gpt4 /review
请注意一些信息如帮助信息可能也会依然显示codegpt StarShip现已上架GitHub让你的代码审查更智能、更高效 立即安装让开发更轻松
