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

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

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

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

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

创建项目规则后，Amazon Q Developer 将自动将其用作项目中的上下文，并确保在生成功能开发代码时遵守这些规则。

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

  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 将在您的项目中自动使用这些规则作为上下文。