CodeCatalyst で問題を作成する - Amazon CodeCatalyst
Amazon Q に割り当てた問題に関するベストプラクティス

CodeCatalyst で問題を作成する

開発チームは、作業を追跡および管理するために問題を作成します。プロジェクト内で、必要に応じて問題を作成できます。例えば、コード内の変数の更新を追跡する問題を作成できます。プロジェクト内の他のユーザーに問題を割り当てる、作業の追跡に役立つラベルを使用するなどが可能です。

CodeCatalyst で問題を作成する手順は次のとおりです。

問題を作成するには

  1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

  2. 問題を作成するプロジェクトに移動します。

  3. プロジェクトのホームページで、[問題の作成] を選択します。または、ナビゲーションペインで [問題] を選択します。

  4. [問題の作成] を選択します。

    注記

    グリッドビューを使用している場合は、問題をインラインで追加することもできます。

  5. 問題のタイトルを入力します。

  6. (オプション) [説明] を入力します。Markdown を使用して書式を追加できます。

  7. (オプション) 問題の [ステータス]、[優先度]、[見積もり] を選択します。

    注記

    プロジェクトの見積り設定が [見積りを非表示] に設定されている場合、[見積り] フィールドは表示されません。

  8. (オプション) 問題にタスクを追加します。タスクは、問題の作業を小さな目標に分解するために使用できます。タスクを追加するには、[+ タスクの追加] を選択します。次に、テキストフィールドにタスク名を入力し、Enter キーを押します。タスクを追加したら、チェックボックスをオンにして完了としてマークするか、チェックボックスの左側でタスクをクリックしてドラッグすることで順序を変更できます。

  9. (オプション) 既存のラベルを追加するか、新しいラベルを作成し、[+ ラベルを追加] を選択して追加します。

    1. 既存のラベルを追加するには、リストからラベルを選択します。フィールドに検索語を入力して、プロジェクト内のその語句を含むすべてのラベルを検索できます。

    2. 新しいラベルを作成して追加するには、作成するラベルの名前を検索フィールドに入力し、Enter キーを押します。

  10. (オプション) [+ 担当者を追加] を選択して、担当者を追加します。[+ 自分を追加] を選択すると、自分を担当者としてすばやく追加できます。

    ヒント

    Amazon Q に問題を割り当てることで、Amazon Q で問題の解決を試みることができます。詳細については、「チュートリアル: CodeCatalyst の生成 AI 機能を使用して開発作業を高速化する」を参照してください。この機能は、米国西部 (オレゴン) リージョンでのみ利用可能です。

    この機能を使用するには、スペースに対して生成 AI 機能を有効にする必要があります。詳細については、「Managing generative AI features」を参照してください。

  11. (オプション) 既存の [カスタムフィールド] を追加するか、新しいカスタムフィールドを作成します。問題には、複数のカスタムフィールドを含めることができます。

    1. 既存のカスタムフィールドを追加するには、リストからカスタムフィールドを選択します。フィールドに検索語を入力して、プロジェクト内のその語句を含むすべてのカスタムフィールドを検索できます。

    2. 新しいカスタムフィールドを作成して追加するには、作成するカスタムフィールドの名前を検索フィールドに入力し、Enter キーを押します。次に、作成するカスタムフィールドのタイプを選択し、値を設定します。

  12. [問題の作成] を選択します。右下隅に通知が表示されます。問題が正常に作成された場合、問題が正常に作成されたことを示す確認メッセージが表示されます。問題が正常に作成されなかった場合、失敗の理由を示すエラーメッセージが表示されます。その後、[再試行] を選択して問題を編集し、作成を再試行するか、[破棄] を選択して問題を破棄できます。どちらのオプションを選択した場合も、通知は解除されます。

    注記

    プルリクエストの作成時に、プルリクエストを問題にリンクすることはできません。ただし、作成した後に問題を編集して、プルリクエストへのリンクを追加できます。

Amazon Q に割り当てた問題を作成および処理する際のベストプラクティス

問題を作成すると、問題がなかなか解決されない場合があります。その原因は複雑でさまざまです。誰がその問題に取り組むべきかが明確でないことが原因である場合があります。また、問題によっては、コードベースの特定の部分に関する調査や専門知識が必要で、その作業に最適な担当者が他の問題で忙しいこともあります。他の緊急の作業が優先される場合もあります。こうした原因の 1 つまたはすべてが要因となり、問題が取り組まれない事態を招く可能性があります。CodeCatalyst には、Amazon Q と呼ばれる生成 AI アシスタントとの統合機能が組み込まれています。Amazon Q は、問題のタイトルとその説明に基づいて問題を分析できます。Amazon Q に問題を割り当てると、評価用のソリューションの試案を作成しようとします。これにより、すぐにリソースを割くことができない問題の解決には Amazon Q を活用しながら、自分やチームは注意が必要な問題に集中して取り組むことで最適化を図ることができます。

注記
注記

Amazon Bedrock を搭載: AWS は不正使用の自動検出を実装します。Amazon Q Developer Agent for Software Development の「説明を記述する」、「内容の要約を作成する」、「タスクを推奨する」、「Amazon Qを使用してプロジェクトに機能を作成または追加する」、「Amazon Q に問題を割り当てる」機能は Amazon Bedrock を基盤に構築されているため、ユーザーは Amazon Bedrock に実装されている統制を最大限に活用して、AI の安全性、セキュリティ、責任ある使用を徹底することができます。

Amazon Q は、単純な課題や簡単な問題で優れたパフォーマンスを発揮します。最良の結果を得るには、何をしてもらいたいかを明確に説明する簡潔な表現を使用してください。以下は、Amazon Q が取り組むために最適化された問題を作成するためのベストプラクティスです。

重要

生成 AI 機能は、米国西部 (オレゴン) リージョンでのみ使用できます。

  • シンプルにまとめる。Amazon Q は、問題のタイトルと説明を見れば理解できる単純なコード変更や修正に最適です。あいまいなタイトルや飾りすぎた表現、矛盾する説明を含む問題を割り当てないでください。

  • 具体的に記述する。問題を解決するために必要な変更についてより正確に多くの情報を提供できればできるほど、Amazon Q が問題の解決策を考案できる可能性が高くなります。可能であれば、変更する API の名前、更新するメソッド、変更が必要なテスト、その他考えられる詳細など、具体的な詳細を含めます。

  • Amazon Q に割り当てる前に、問題のタイトルと説明にすべての詳細が含まれていることを確認してください。Amazon Q に割り当てた後、問題のタイトルや説明を変更することはできません。そのため、Amazon Q に割り当てる前に、問題に必要なすべての情報が提供されていることを確認してください。

  • 1 つのソースリポジトリでのコード変更が必要な問題のみを割り当てる。Amazon Q は、CodeCatalyst の 1 つのソースリポジトリのコードのみを処理できます。リンクされたリポジトリはサポートされていません。Amazon Q にその問題を割り当てる前に、問題が 1 つのソースリポジトリでの変更のみを必要とすることを確認してください。

  • 各ステップを承認するために、Amazon Q が推奨するデフォルトを使用する。デフォルトでは、Amazon Q は実行する各ステップに対してユーザーの承認を必要とします。これにより、問題に関するコメントだけでなく、Amazon Q が作成するプルリクエストでも Amazon Q とやりとりできます。これにより、Amazon Q をよりインタラクティブに操作することができ、問題解決に向けた Amazon Q のアプローチを調整し、Amazon Q が作成したコードを改良できます。

    注記

    Amazon Q は、問題やプルリクエストに関する個々のコメントには応答しませんが、アプローチを再検討したり、リビジョンを作成したりするように求められると、レビューを行います。

  • Amazon Q が提案するアプローチを必ず慎重にレビューする。アプローチを承認すると、Amazon Q はそのアプローチに基づいてコードの生成作業を開始します。作業を進めるように Amazon Q に指示する前に、アプローチが適切かどうか、想定されるすべての詳細が含まれていることを確認してください。

  • Amazon Q がワークフローで作業させる場合は、そのワークフローをレビューする前にデプロイする可能性のある既存のワークフローがないことを確認してください。プロジェクトで、プルリクエストのイベントで実行を開始するようにワークフローが設定されている場合があります。その場合、Amazon Q が作成する、ワークフロー YAML の作成または更新を含むプルリクエストは、プルリクエストに含まれるワークフローの実行を開始する可能性があります。ベストプラクティスとして、Amazon Q がワークフローファイルを操作することを許可しないでください。許可する場合は、Amazon Q が作成したプルリクエストをレビューして承認する前に、これらのワークフローを自動的に実行するワークフローがプロジェクトにないことを確認してください。

詳細については、「チュートリアル: CodeCatalyst の生成 AI 機能を使用して開発作業を高速化する」および「Managing generative AI features」を参照してください。