与 Amazon Q 开发者一起查看代码 GitHub - Amazon Q 开发者版

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

与 Amazon Q 开发者一起查看代码 GitHub

注意

Amazon Q 开发者版GitHub为预览版,可能会发生变化。

Amazon Q Developer 支持内部的自动代码审查GitHub。当您创建新的拉取请求或重新打开已关闭的拉取请求时,Amazon Q Developer 会自动执行代码审查,并就代码质量、潜在问题和高严重性发现提供反馈。Amazon Q Developer 还会针对已发现的问题生成修复程序,您可以查看这些修复程序并选择提交拉取请求。在现有拉取请求中进行的后续提交不会触发自动代码审查。

您也可以使用 s /q review lash 命令在拉取请求中启动代码审查。可以将斜杠命令添加到新的拉取请求注释中,这会启动对拉取请求当前状态的新代码审查,包括所有评论和新提交。有关更多信息,请参阅 在GitHub拉取请求中向 Amazon Q 开发者发起代码审查

您可以让 Amazon Q Developer 每月对有限数量的行进行代码审查。您可以随时通过使用您的 AWS 账户注册安装的 Amazon Q Developer 应用程序来增加免费使用量。有关更多信息,请参阅 提高使用限制并在 Amazon Q 开发者控制台中配置详细信息

注意

如果之前禁用了代码审查功能,则必须先在 Amazon Q Developer 控制台中启用该功能,然后才能在中应用标签GitHub。有关更多信息,请参阅 中为 Amazon Q 开发者提供的编辑功能 GitHub

使用 Amazon Q Developer 进行代码审查和应用修复

在开始审查之前,您可以通过在project-root/.amazonq/rules目录中的简单 Markdown 文件中定义自定义编码标准来自定义代码质量审查。Amazon Q 会自动遵循您的指南,确保整个项目的代码质量保持一致。有关更多信息,请参阅 在第三方平台上为 Amazon Q 开发者创建项目规则

  1. 如有必要,请使用您的GitHub凭证登录您的GitHub账户。

  2. 导航到您的GitHub组织,然后导航到要与 Amazon Q Developer 一起进行代码审查的存储库。

  3. 为源代码所做的更改创建新的拉取请求。有关更多信息,请参阅GitHub 文档中的创建拉取请求

    当您创建新的拉取请求时,Amazon Q Developer 会自动开始代码审查以发现潜在问题。Amazon Q Developer 完成审核后,它会将每项发现作为单独的评论提交,以及您可以提交拉取请求的修复建议。

  4. 查看 Amazon Q Developer 提出的代码更改,选择提交建议,然后选择提交更改以更新拉取请求。

  5. 如果您对建议的代码修复感到满意,则可以合并拉取请求以应用 Amazon Q Developer 建议的代码更改。有关更多信息,请参阅GitHub 文档中的合并拉取请求

在GitHub拉取请求中向 Amazon Q 开发者发起代码审查

在 Amazon Q Developer 对新的或重新打开的GitHub拉取请求执行自动代码审查后,您可以使用/q review斜杠命令启动其他代码审查以迭代代码。代码审查是针对整个拉取请求的差异进行的。

注意

您只能在带有新评论的拉取请求中启动代码审查。/q review斜杠命令在现有的评论话题中不起作用。

在拉取请求中使用启动代码审查
  1. 如有必要,请使用您的GitHub凭证登录您的GitHub账户。

  2. 导航到您的GitHub组织,然后导航到您要与 Amazon Q Developer 一起进行代码审查的拉取请求。有关更多信息,请参阅关于拉取请求

  3. 在拉取请求中,导航到添加评论,然后在评论文本输入字段中输入/q review

  4. 选择 “注释” 以启动代码审查。

    Amazon Q 开发者可能需要几分钟才能完成拉取请求代码的分析。在 Amazon Q Developer 完成分析后,它会回复您的评论,并附上其关键和严重性调查结果,以及您可以选择提交和更新拉取请求的拟议更改。

  5. 如果您对建议的代码修复感到满意,则可以合并拉取请求以应用 Amazon Q Developer 建议的代码更改。有关更多信息,请参阅GitHub 文档中的合并拉取请求