サードパーティープラットフォームでの Amazon Q Developer のプロジェクトルールの作成 - Amazon Q Developer

サードパーティープラットフォームでの Amazon Q Developer のプロジェクトルールの作成

Amazon Q Developer で使用できるプロジェクトルールのライブラリを GitLab または 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 は、これらのルールをプロジェクト内でコンテキストとして自動的に使用します。