リポジトリに問題を作成して、作業の計画、議論、追跡を行うことができます。 issue は迅速に作成でき、柔軟性があり、さまざまな方法で使用できます。 Issue では、バグレポート、新機能、アイデアのほか、チームで記録したり議論したりする必要のあるあらゆる事柄を追跡でき、プロジェクト を使用してチームの作業を計画および追跡できます。 また、サブイシューを追加して作業をさらに分解し、実行する作業の階層全体を簡単に参照することもできます。
Issueは様々な方法で作成できるので、ワークフローで最も便利な方法を選択できます。 たとえば、リポジトリから問題を作成し、サブイシューを追加しながら したり、問題や pull request でコメントを変換 、特定のコード行から問題を作成したり、URL クエリを使用したりできます。 Web UI、 GitHub Desktop、 GitHub CLI、GraphQL および REST API、または GitHub Mobileを使用して、任意のプラットフォームから問題を作成することもできます。 「課題の作成」を参照してください。
サブ問題について
Issue に sub-issue を追加することで、大きな作業を小さな issue にすばやく分割することができます。 sub-issue により、issue 間の関係が作成されて、GitHub での issue の階層のサポートが追加されます。 ユーザーやチームが必要とする詳細さにタスクを分割することでプロジェクトを正確に表す sub-issue の複数のレベルを作成することができます。 「AUTOTITLE」と「AUTOTITLE」を参照してください。
課題の依存関係について
課題の依存関係を使って、課題間のブロックする関係を定義できます。 Issue の依存関係を利用して、他の作業によってブロックされている Issue または他の作業をブロックしている Issue を特定できます。 「課題の依存関係の作成」を参照してください。
問題のメタデータ
issue 型、ラベル、マイルストーンなど、問題にメタデータを追加して問題を整理できます。
「 組織での課題の種類の管理、 ラベルを管理する 、 マイルストーンについて」を参照してください。
GitHubとの統合について
課題は、GitHub全体にわたって作業の流れに統合されます。 別の issue または pull request の問題に言及すると、pull request でそれらの間に参照が作成され、fixes: などのキーワードを使用すると、関連する issue が自動的に閉じられます。 「プルリクエストを課題にリンクする」を参照してください。
プロジェクトを使って作業を計画し、進捗を追跡する
プロジェクト は、チームの作業を計画および追跡するための問題と強く統合されています。 すべての issue メタデータをプロジェクトで使用できるため、作業を表すビューとフィルターを作成できます。 「Projects の概要」を参照してください。
最新の状態に保つ
Issueの最新のコメントの情報を得ておきたい場合には、Issueをサブスクライブして最新のコメントに関する通知を受け取ることができます。 サブスクライブした Issue の最新の更新へのリンクを素早く見つけるには、ダッシュボードにアクセスしてください。 詳細については、「通知について」および「個人用ダッシュボードのクイック スタート」を参照してください。
自分とチームメイトを問題に割り当てて、問題に取り組んでいるユーザーを明確にし、問題を見つけやすくすることができます。 「他のGitHub ユーザーに問題とプル要求を割り当てる」と「すべての issue と pull request を表示する」を参照してください。
コミュニティの管理
共同作成者が必要な情報を提供する意味のある問題を開くために、 issue テンプレートを使用できます。 「テンプレートを使用して便利な Issue やプルリクエストを促進する」を参照してください。
効率的なコミュニケーション
コメントに注意を惹きつけるために、issue 内でリポジトリにアクセスできるコラボレーターを @mention できます。 関連する課題を同じリポジトリ内でリンクするためには、# を入力した後、課題タイトルの一部を続けて入力し、リンクしたい課題をクリックします。 責任を伝えるために、課題を割り当てることができます。 同じコメントを頻繁に入力しているなら、返信テンプレートを利用できます。
問題とディスカッションの比較
一部の会話は、 GitHub Discussionsに適しています。 GitHub Discussions を使用すると、質問、質問への回答、情報の共有、発表、および製品に関する会話や会話への参加を行うことができます。 詳しくは、「ディスカッションについて」をご覧ください。 問題またはディスカッションを使用する場合のガイダンスについては、 GitHubでの通信 を参照してください。
Issue内での会話にディスカッションの方が適している場合は、Issueをディスカッションに変換できます。
次のステップ
GitHub Issuesで次の手順を実行するために役立つリソースを次に示します。
- 課題の使用を開始する方法については、「GitHubイシューのクイックスタート入門ガイド」を参照してください。
- GitHubの計画および追跡ツールを使用するための基本事項については、「チームまたはプロジェクトの作業の計画と管理を参照してください。
- プロジェクトが計画と追跡にどのように役立つかの詳細については、「Projects について学習する」を参照してください。