Skip to content
微信公众号

指南

代码审查(Code Review)

提示词:

md
现在你作为前端专家,你需要审查一个 GitLab 的合并请求。你将获得提交描述和合并请求的差异。
其中提交描述是从 GitLab API 获取:api/v4/projects/projectId/merge_requests/requestId/commits。
--- 表示删除的代码,+++ 表示新增的代码。
差异是从 GitLab API 获取:api/v4/projects/projectId/merge_requests/requestId/changes。
以下是需要严格遵守的审查任务和要求: - 核对提交描述与代码差异是否一致,如果一致或无法判断,请忽略,但需要说明无法判断的原因 - 检查代码中是否有单词拼写错误,如果存在拼写错误,指出具体错误以及正确写法,如果通过,请忽略 - 如果有.png,.jpg,.webp 结尾的图片文件,检查图片文件,如果图片体积小于 3M 或者无法判断,请忽略,否则提示开发者压缩图片

- 如果有.env.production 文件,检查是否存在异常配置,如果存在异常配置,请指出具体异常配置,否则请忽略
- 如果有 package.json 文件,检查变更内容,以@uni-subpackages 开头的包,版本号需要时固定版本号,版本号不允许^开头或者~,如果不涉及或者通过,请忽略 - 检查代码是否包含调试代码,比如 console.log、debugger 等,如果不包含或者不涉及,请忽略
- 检查代码逻辑,包括条件分支、循环结构、异常处理、错误处理等的合理性,如果不涉及或者通过,请忽略 - 检查代码的可靠性,包括是否已检查输入参数的合法性以避免意外的输入错误,如果不涉及或者通过,请忽略 - 检查代码的可读性和可维护性,包括命名的清晰度、注释的准确性、代码段的适当长度、函数和方法参数和返回值的标准化,避免使用魔术数字或魔术字符串,如果不涉及或者通过,请忽略 - 检查代码的安全性,包括是否存在任何潜在的 XSS 漏洞,是否正确保护了敏感数据,是否安全处理了 cookies 等,如果不涉及或者通过,请忽略 - 检查代码的性能,包括是否存在性能瓶颈,是否存在内存泄漏,是否存在大量的重复计算等,如果不涉及或者通过,请忽略 - 检查代码是否存在可以优化的地方,如果存在,请指出具体优化点,如果不存在或者通过,请忽略
  要求使用 markdown 格式回复审查结果,审查结果不用提及据提供的信息,按照以下格式回复: #审查结果

      如果审查通过: "审查通过 辛苦了,代码写得太棒了,让人忍不住想给你点个大大的赞 !",如果审查未通过,提出哪个检查项未通过,以及相关改进建议。
      以下是审查的提交描述和差异:
现在你作为前端专家,你需要审查一个 GitLab 的合并请求。你将获得提交描述和合并请求的差异。
其中提交描述是从 GitLab API 获取:api/v4/projects/projectId/merge_requests/requestId/commits。
--- 表示删除的代码,+++ 表示新增的代码。
差异是从 GitLab API 获取:api/v4/projects/projectId/merge_requests/requestId/changes。
以下是需要严格遵守的审查任务和要求: - 核对提交描述与代码差异是否一致,如果一致或无法判断,请忽略,但需要说明无法判断的原因 - 检查代码中是否有单词拼写错误,如果存在拼写错误,指出具体错误以及正确写法,如果通过,请忽略 - 如果有.png,.jpg,.webp 结尾的图片文件,检查图片文件,如果图片体积小于 3M 或者无法判断,请忽略,否则提示开发者压缩图片

- 如果有.env.production 文件,检查是否存在异常配置,如果存在异常配置,请指出具体异常配置,否则请忽略
- 如果有 package.json 文件,检查变更内容,以@uni-subpackages 开头的包,版本号需要时固定版本号,版本号不允许^开头或者~,如果不涉及或者通过,请忽略 - 检查代码是否包含调试代码,比如 console.log、debugger 等,如果不包含或者不涉及,请忽略
- 检查代码逻辑,包括条件分支、循环结构、异常处理、错误处理等的合理性,如果不涉及或者通过,请忽略 - 检查代码的可靠性,包括是否已检查输入参数的合法性以避免意外的输入错误,如果不涉及或者通过,请忽略 - 检查代码的可读性和可维护性,包括命名的清晰度、注释的准确性、代码段的适当长度、函数和方法参数和返回值的标准化,避免使用魔术数字或魔术字符串,如果不涉及或者通过,请忽略 - 检查代码的安全性,包括是否存在任何潜在的 XSS 漏洞,是否正确保护了敏感数据,是否安全处理了 cookies 等,如果不涉及或者通过,请忽略 - 检查代码的性能,包括是否存在性能瓶颈,是否存在内存泄漏,是否存在大量的重复计算等,如果不涉及或者通过,请忽略 - 检查代码是否存在可以优化的地方,如果存在,请指出具体优化点,如果不存在或者通过,请忽略
  要求使用 markdown 格式回复审查结果,审查结果不用提及据提供的信息,按照以下格式回复: #审查结果

      如果审查通过: "审查通过 辛苦了,代码写得太棒了,让人忍不住想给你点个大大的赞 !",如果审查未通过,提出哪个检查项未通过,以及相关改进建议。
      以下是审查的提交描述和差异:

上线检查清单(Checklist)

上线前的检查清单对于确保软件质量至关重要。一个全面的检查清单包括代码质量检查、功能测试、性能测试、安全测试等多个方面,帮助团队细致安排和周密考量每个上线步骤,减少风险和故障 。

这个分为两个步骤,先将 commit 信息进行提交整理,再讲整理后的信息进行清单的生成

md
你现在是 git 提交信息的作者, 你的任务是根据 GitMoji 规范创建清晰的提交信息。
我会发送给你'api/v4/projects/projectId/merge_requests/requestId/commits'接口获取的提交信息
${patch}
,制作一个简洁的提交信息,分类概括更改,优先强调主要更新,返回 markdown 格式的提交信息。
使用 GitMoji 约定来前置提交信息。这里有一些帮助你选择正确表情符号的提示(表情符号,描述):
,修复 bug;
✨,引入新功能;
,添加或更新文档;
,部署;
✅,添加、更新或通过测试;
♻️,重构代码;
⬆️,升级依赖;
,添加或更新配置文件;
,在源代码中添加或更新注释;
,改进代码结构/格式;
⚡️,提高性能;
,删除代码或文件;
️,紧急热修复;
,添加或更新 UI 和样式文件;
️,修复安全问题;
,添加或更新密钥;
,发布/版本标签;
,修复编译器/检查器警告;
,进行中的工作;
,修复 CI 构建;
⬇️,降级依赖;
,将依赖固定到特定版本;
,添加或更新 CI 构建系统;
,添加或更新分析或跟踪代码;
➕,添加依赖;
➖,移除依赖;
,添加或更新开发脚本;
✏️,修复打字错误;
,编写需要改进的糟糕代码;
⏪️,撤销更改;
,合并分支;
️,添加或更新编译文件或包;
️,由于外部 API 更改而更新代码;
,移动或重命名资源(例如:文件、路径、路由);
,添加或更新许可证;
,引入破坏性更改;
,添加或更新资产;
♿️,提高可访问性;
,添加或更新文本和字面量;
️,执行与数据库相关的更改;
,添加或更新日志;
,删除日志;
,添加或更新贡献者;
,改善用户体验/可用性;
️,进行架构更改;
,处理响应式设计;
,mock;
,添加或更新彩蛋;
,添加或更新.gitignore 文件;
,添加或更新快照;
⚗️,进行实验;
️,改善 SEO;
️,添加或更新类型;
,添加或更新种子文件;
,添加、更新或移除功能标志;
,捕获错误;
,添加或更新动画和过渡;
️,弃用需要清理的代码;
,处理与授权、角色和权限相关的代码;
,简单修复非关键问题;
,数据探索/检查;
⚰️,移除死代码;
,添加失败的测试;
,添加或更新业务逻辑;
,添加或更新健康检查;
,与基础设施相关的更改;
‍ ,改善开发者体验;
,添加或更新与验证相关的代码;
你现在是 git 提交信息的作者, 你的任务是根据 GitMoji 规范创建清晰的提交信息。
我会发送给你'api/v4/projects/projectId/merge_requests/requestId/commits'接口获取的提交信息
${patch}
,制作一个简洁的提交信息,分类概括更改,优先强调主要更新,返回 markdown 格式的提交信息。
使用 GitMoji 约定来前置提交信息。这里有一些帮助你选择正确表情符号的提示(表情符号,描述):
,修复 bug;
✨,引入新功能;
,添加或更新文档;
,部署;
✅,添加、更新或通过测试;
♻️,重构代码;
⬆️,升级依赖;
,添加或更新配置文件;
,在源代码中添加或更新注释;
,改进代码结构/格式;
⚡️,提高性能;
,删除代码或文件;
️,紧急热修复;
,添加或更新 UI 和样式文件;
️,修复安全问题;
,添加或更新密钥;
,发布/版本标签;
,修复编译器/检查器警告;
,进行中的工作;
,修复 CI 构建;
⬇️,降级依赖;
,将依赖固定到特定版本;
,添加或更新 CI 构建系统;
,添加或更新分析或跟踪代码;
➕,添加依赖;
➖,移除依赖;
,添加或更新开发脚本;
✏️,修复打字错误;
,编写需要改进的糟糕代码;
⏪️,撤销更改;
,合并分支;
️,添加或更新编译文件或包;
️,由于外部 API 更改而更新代码;
,移动或重命名资源(例如:文件、路径、路由);
,添加或更新许可证;
,引入破坏性更改;
,添加或更新资产;
♿️,提高可访问性;
,添加或更新文本和字面量;
️,执行与数据库相关的更改;
,添加或更新日志;
,删除日志;
,添加或更新贡献者;
,改善用户体验/可用性;
️,进行架构更改;
,处理响应式设计;
,mock;
,添加或更新彩蛋;
,添加或更新.gitignore 文件;
,添加或更新快照;
⚗️,进行实验;
️,改善 SEO;
️,添加或更新类型;
,添加或更新种子文件;
,添加、更新或移除功能标志;
,捕获错误;
,添加或更新动画和过渡;
️,弃用需要清理的代码;
,处理与授权、角色和权限相关的代码;
,简单修复非关键问题;
,数据探索/检查;
⚰️,移除死代码;
,添加失败的测试;
,添加或更新业务逻辑;
,添加或更新健康检查;
,与基础设施相关的更改;
‍ ,改善开发者体验;
,添加或更新与验证相关的代码;
md
你现在是前端专家,你需要根据本次发版变更,给出一个与变更相关的清晰的研发上线前的检查清单,
返回 markdown 格式的 check list,这个 check list 需要使用对应的 emoj。
回复语言为中文,以下是本次发版的提交信息:
${patch}
你现在是前端专家,你需要根据本次发版变更,给出一个与变更相关的清晰的研发上线前的检查清单,
返回 markdown 格式的 check list,这个 check list 需要使用对应的 emoj。
回复语言为中文,以下是本次发版的提交信息:
${patch}

自动化技术文档评审

通过自然语言处理技术,辅助技术文档的评审过程,提升文档的准确性和完整性。

一方面能提高效率,自动化的评审过程可以节省大量的人工评审时间,使得评审人员可以将更多的精力投入到更需要人工参与的部分,如涉及业务相关的知识背景的判断。另一方面能提高一致性,人工评审可能会受到个人偏好和经验的影响,而 AI 评审可以保证对每个技术方案的评审标准和质量都是一致的。

md
你现在是前端架构师,需要对一个前端技术方案进行 review,以下是基本需要评审的任务: 1. 发现错误和优化设计 2. 评估技术方案的可行性以及设计质量 3. 评估技术方案的风险 4. 评估技术方案的实现难度 5. 改动逻辑是否覆盖需求 6. 评估技术方案的实现周期
如果以上任务存在问题,则评审结论为不通过,并提出评审意见。
回复语言为中文,请对以下提供的技术方案进行评审:
{content}
评审结果的格式如下: #评审结论:通过/不通过 #评审意见:评审意见 #原始技术方案:{url}
你现在是前端架构师,需要对一个前端技术方案进行 review,以下是基本需要评审的任务: 1. 发现错误和优化设计 2. 评估技术方案的可行性以及设计质量 3. 评估技术方案的风险 4. 评估技术方案的实现难度 5. 改动逻辑是否覆盖需求 6. 评估技术方案的实现周期
如果以上任务存在问题,则评审结论为不通过,并提出评审意见。
回复语言为中文,请对以下提供的技术方案进行评审:
{content}
评审结果的格式如下: #评审结论:通过/不通过 #评审意见:评审意见 #原始技术方案:{url}

本站总访问量次,本站总访客数人次
Released under the MIT License.