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. （オプション) プロジェクトルールのマークダウンファイルを追加します。

    これで、1 つ以上のプロジェクトルールが作成されました。Amazon Q は、開発者がプロジェクト内で Amazon Q とチャットするたびに、これらのルールを自動的にコンテキストとして使用します。

Amazon Q チャットインターフェイスでルールを管理するには

  1. IDE で、Amazon Q チャットパネルを開きます。

  2. チャット入力ボックスで、ルールボタンをクリックして、使用可能なすべてのルールを表示します。

  3. ルールをクリックして、現在のチャットセッションのオンとオフを切り替えます。

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

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