在第三方平台中为 Amazon Q 开发者版创建项目规则 - Amazon Q 开发者版

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

在第三方平台中为 Amazon Q 开发者版创建项目规则

您可以构建一个项目规则库，用于在 GitLab 或 GitHub 中搭配 Amazon Q 开发者版使用。这些规则用于定义团队通用的编码标准和最佳实践。例如，您可以制定一条规则，要求所有 Python 代码必须使用类型提示，或所有 Java 代码必须添加 Javadoc 注释。将这些规则存储在项目中，可确保无论开发人员经验水平如何，都能保持编码一致性。

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

创建项目规则后，Amazon Q 开发者版会自动将其作为项目内的上下文信息，并且在为功能开发生成代码时，确保遵循这些规则。

要通过文件系统创建项目规则，请执行以下操作

  1. 在您的第三方存储库中，打开项目的根文件夹。

  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 会自动将这些规则作为项目内的上下文信息使用。