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

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

GitLab または GitHub GitHub の Amazon Q Developer で使用できるプロジェクトルールのライブラリを構築できます。これらのルールでは、チーム全体のコーディング標準とベストプラクティスについて説明します。たとえば、すべての 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. （オプション) プロジェクトルールのマークダウンファイルを追加します。

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