创建用于 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. 点击某条规则，可切换其在当前聊天会话中的“启用/禁用”状态：

    • 带有勾选标记的规则为“已启用”状态，会应用于当前对话。

    • 无勾选标记的规则为“已禁用”状态，在当前会话中不生效。