在中创建问题 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 生成式 AI 功能加快开发工作。此功能仅在美国西部(俄勒冈)区域可用。

    此功能要求为该空间启用生成式 AI 功能。有关更多信息,请参阅管理生成式 AI 功能

  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 进行优化的问题以供处理。

重要

生成式 AI 功能仅在美国西部(俄勒冈)地区可用。

  • 简单一点。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 生成式 AI 功能加快开发工作和管理生成式 AI 功能