在中创建问题 CodeCatalyst - Amazon CodeCatalyst

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

在中创建问题 CodeCatalyst

开发团队创建事务来帮助跟踪和管理他们的工作。您可以根据您的需求在项目中创建事务。例如,您可以创建事务来更新代码中的变量。您可以将事务分配给项目中的其他用户,使用标签来帮助您跟踪工作等。

按照以下说明在中创建问题 CodeCatalyst。

创建事务
  1. 打开 CodeCatalyst 控制台,网址为 https://codecatalyst.aws/

  2. 导航到要在其中创建事务的项目。

  3. 在项目主页上,选择创建事务。或者,在导航窗格中,选择事务

  4. 选择创建事务

    注意

    在使用网格视图时,也可以内联方式添加事务。

  5. 输入事务的标题。

  6. (可选)输入描述。您可以使用 Markdown 添加格式。

  7. (可选)选择事务的状态优先级估算

    注意

    如果项目的估算设置设为隐藏估算,则不会显示估算字段。

  8. (可选)向事务添加任务。任务可用于将事务的工作分成多个小目标。要添加任务,请选择 + 添加任务。然后,在文本字段中输入任务名称并按 Enter。添加任务后,您可以通过选中复选框将任务标记为已完成,或者通过从复选框左侧选择并拖动任务来重新为任务排序。

  9. (可选)添加现有标签或创建一个新标签并通过选择 + 添加标签来添加该标签。

    1. 要添加现有标签,请从列表中选择该标签。您可以在字段中输入一个搜索词来搜索项目中所有包含该搜索词的标签。

    2. 要创建并添加新标签,请在搜索字段中输入要创建的标签的名称,然后按 Enter。

  10. (可选)通过选择 + 添加被分派人来添加被分派人。您可以通过选择 + 添加我来快速将自己添加为被分派人。

    提示

    您可以选择将事务分配给 Amazon Q,让 Amazon Q 尝试解决该事务。有关更多信息,请参阅教程:使用 CodeCatalyst 生成式人工智能功能来加快开发工作。此功能仅在美国西部(俄勒冈州)区域中提供。

    此功能要求为空间启用生成式人工智能功能。有关更多信息,请参阅 Managing generative AI features

  11. (可选)添加现有的自定义字段或创建新的自定义字段。事务可具有多个自定义字段。

    1. 要添加现有的自定义字段,请从列表中选择该自定义字段。您可以在字段中输入一个搜索词来搜索项目中所有包含该搜索词的自定义字段。

    2. 要创建并添加新的自定义字段,请在搜索字段中输入要创建的自定义字段的名称,然后按 Enter。然后选择要创建的自定义字段的类型并设置一个值。

  12. 选择创建事务。右下角将显示一条通知:如果已成功创建事务,则会显示一条确认消息,指明已成功创建事务。如果事务创建失败,则会显示一条错误消息,指明失败的原因。之后,您可以选择重试以进行编辑并重试创建事务,或选择放弃以放弃事务。选择这两个选项都将关闭通知。

    注意

    在创建一个事务时,无法将拉取请求链接到该事务。不过,您可以在创建事务后编辑它,以添加拉取请求的链接。

创建和处理分配给 Amazon Q 的事务时的最佳实践

在创建事务时,有时一些事务会持续存在。导致出现这种情况的原因可能是复杂而多变的。有时是因为不知道谁将处理事务。其他时候,事务需要对代码库的特定部分进行研究或有专门的了解,而这项工作的最佳候选人却忙于处理其他事务。通常还需优先处理其他紧急工作。这些原因中的任何一个或全部都可能导致无法解决的问题。 CodeCatalyst 包括与名为 Amazon Q 的生成式 AI 助手的集成,该助手可以根据问题的标题和描述来分析问题。如果您将事务分配给 Amazon Q,它将尝试创建解决方案草稿以供您评估。这有助于您和您的团队专注于并优化处理需要关注的事务,而 Amazon Q 则专注于解决您没有资源来立即解决的问题。

注意
注意

由 Amazon Bedrock 提供支持: AWS 实现自动滥用检测。由于为我编写描述创建内容摘要推荐任务使用 Amazon Q 创建功能或将功添加到项目以及将事务分配给 Amazon Q 功能与用于软件开发的 Amazon Q 开发者版代理程序的功能都是基于 Amazon Bedrock 构建的,因此,用户可以充分利用 Amazon Bedrock 中实施的控制措施来强制实施安全性并负责任地使用人工智能(AI)。

Amazon Q 能够出色地处理简单的事务和问题。为了获得最佳结果,请使用简明易懂的语言来清楚地说明您要执行的操作。以下是一些最佳实践,可帮助您创建优化的事务以供 Amazon Q 处理。

重要

生成式人工智能功能仅在美国西部(俄勒冈州)区域中可用。

  • 保持简单。Amazon Q 能够出色地处理简单的代码更改和修复,可以在事务的标题和描述中说明这些更改和修复。请勿分配具有模糊的标题或过于华丽或相互矛盾的描述的事务。

  • 具体化。您提供的有关解决事务所需的确切更改的信息越多,Amazon Q 创建出解决该事务的解决方案的可能性就越高。如果可能,请包括具体的细节,例如要更改的 APIs 名称、要更新的方法、需要更改的测试以及您能想到的任何其他细节。

  • 在将事务分配给 Amazon Q 之前,请确保事务的标题和描述中包含所有详细信息。在将事务分配给 Amazon Q 之后,无法更改其标题或描述,因此,在将事务分配给 Amazon Q 之前,请确保您拥有事务中所需的所有信息。

  • 仅分配需要在单一源存储库中更改代码的事务。Amazon Q 只能在中处理单源存储库中的代码 CodeCatalyst。不支持链接的存储库。在将事务分配给 Amazon Q 之前,请确保该事务只需要在单一源存储库中进行更改。

  • 使用 Amazon Q 建议的默认值来批准每个步骤。默认情况下,您需要审批 Amazon Q 执行的每个步骤。这使您能够针对事务评论以及 Amazon Q 创建的任何拉取请求与之进行交互。这将提供与 Amazon Q 的交互性更高的体验,帮助您调整其方法并优化它为解决事务而创建的代码。

    注意

    Amazon Q 不会响应事务或拉取请求中的单个评论,但它在需要重新考虑其方法或创建修订时将审查这些评论。

  • 请始终仔细审查 Amazon Q 建议的方法。在您批准其方法后,Amazon Q 将开始根据该方法生成代码。在告知 Amazon Q 继续操作之前,请确保该方法看起来正确并包含您期望的所有详细信息。

  • 请确保仅在以下情况下允许 Amazon Q 使用工作流:您没有可在审核方法前部署方法的现有工作流。您的项目可能已将工作流配置为在拉取请求事件上开始运行。如果是这样的话,Amazon Q 创建的任何拉取请求(包括创建或更新工作流 YAML)都可能启动拉取请求中包含的那些工作流的运行。作为最佳实践,请不要选择让 Amazon Q 能够使用工作流文件,除非您确定项目中没有将自动运行这些工作流文件的工作流,然后再审核和批准它创建的拉取请求。

有关更多信息,请参阅教程:使用 CodeCatalyst 生成式人工智能功能来加快开发工作Managing generative AI features