创建用于 Amazon Q 开发者聊天的项目规则 - Amazon Q 开发者版

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

创建用于 Amazon Q 开发者聊天的项目规则

您可以构建一个项目规则库，以便在 IDE 中与 Amazon Q 聊天时使用。这些规则描述了整个团队的编码标准和最佳实践。例如，你可以有一个规则，规定所有 Python 代码都必须使用类型提示，或者所有 Java 代码都必须使用 Javadoc 注释。通过将这些规则存储在项目中，您可以确保开发人员之间的一致性，无论他们的经验水平如何。

项目规则是在项目project-root/.amazonq/rules文件夹中的 Markdown 文件中定义的。

创建项目规则后，每当开发者在您的项目中与 Amazon Q 聊天时，Amazon Q 都会自动将其用作上下文，并确保在生成答案时遵守这些规则。有关为聊天添加上下文的更多信息，请参阅在 IDE 中为 Amazon Q 开发者聊天添加背景信息。

您可以直接在文件系统中创建项目规则，也可以通过 Amazon Q 聊天界面创建项目规则。

使用 Amazon Q 聊天界面创建项目规则

  1. 在你的 IDE 中，打开 Amazon Q 聊天面板。

  2. 在聊天输入框中，点击规则按钮。

  3. 选择 “创建新规则”。

  4. 在出现的对话框中，输入规则的名称。

    这将在你的项目project-root/.amazonq/rules文件夹中创建一个同名的 Markdown 文件。

  5. 在编辑器中添加您的规则内容。

  6. 保存该文件。

使用文件系统创建项目规则

  1. 在 IDE 中，打开项目的根文件夹。

  2. 在项目根文件夹中，创建以下文件夹：

    project-root/.amazonq/rules

    此文件夹包含您的所有项目规则。

  3. 在中project-root/.amazonq/rules，创建项目规则文件。它必须是 Markdown 文件。例如：

    cdk-rules.md

  4. 打开你的项目规则 Markdown 文件。

  5. 在文件中添加详细提示。例如：

    All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access.
All Amazon DynamoDB Streams tables must have encryption enabled. 
All Amazon SNS topics must have encryption enabled and enforce SSL. 
All Amazon SNS queues must enforce SSL.

  6. 保存该文件。

  7. （可选）添加更多项目规则 Markdown 文件。

    现在，您已经创建了一个或多个项目规则。每当开发者在您的项目中与 Amazon Q 聊天时，Amazon Q 都会自动使用这些规则作为上下文。

在 Amazon Q 聊天界面中管理规则

  1. 在你的 IDE 中，打开 Amazon Q 聊天面板。

  2. 在聊天输入框中，点击规则按钮查看所有可用规则。

  3. 点击一条规则，在当前聊天会话中将其开启或关闭：

    • 带有复选标记的规则处于活动状态，并将应用于您的对话。

    • 没有复选标记的规则在当前会话中处于非活动状态。