Amazon Q Developer チャットで使用するプロジェクトルールの作成 - Amazon Q Developer

Amazon Q Developer チャットで使用するプロジェクトルールの作成

IDE で Amazon Q とチャットする際に使用できるプロジェクトルールのライブラリを構築できます。これらのルールは、チーム全体のコーディング標準とベストプラクティスを記述したものです。例えば、すべての Python コードが型ヒントを使用する必要があること、またはすべての Java コードで Javadoc コメントを使用する必要があることを示すルールを作成できます。これらのルールをプロジェクトに保存することで、経験レベルに関係なく、開発者間の一貫性を確保できます。

プロジェクトルールは、プロジェクトの project-root/.amazonq/rules フォルダの Markdown ファイルで定義されます。

プロジェクトルールを作成すると、Amazon Q は開発者がプロジェクト内で Amazon Q とチャットするたびにこれらのルールを自動的にコンテキストとして使用し、ルールに従って回答を生成します。チャットへのコンテキストの追加の詳細については、「IDE の Amazon Q Developer チャットへのコンテキストの追加」を参照してください。

プロジェクトルールは、ファイルシステムまたは 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. ルールをクリックして、現在のチャットセッションでのオンとオフを切り替えます。

    • チェックマークが付いたルールはアクティブで、会話に適用されます。

    • チェックマークのないルールは、現在のセッションでは非アクティブです。