リポジトリに問題を作成して、作業の計画、議論、追跡を行うことができます。 issue は迅速に作成でき、柔軟性があり、さまざまな方法で使用できます。 issue は、バグ レポート、新機能やアイデア、およびチームに書き留めたり、話し合ったりするために必要なものなどを追跡できます。
Issueは様々な方法で作成できるので、ワークフローで最も便利な方法を選択できます。 たとえば、sub-issue の追加中にリポジトリ は、issue またはプル要求のコメントを変換したり、特定のコード行から issue を作成したり、URL クエリを使用して作成したりできます。 Issueは、Web UI、GitHub Desktop、GitHub CLI、GraphQL及びREST API、GitHub Mobileといった好きなプラットフォームから作成することもできます。 「Issue の作成」を参照してください。
GitHub
との統合について
issue は、GitHub
全体で作業と統合されます。 別の issue または pull request の問題に言及すると、pull request でそれらの間に参照が作成され、fixes: などのキーワードを使用すると、関連する issue が自動的に閉じられます。 「Pull RequestをIssueにリンクする」を参照してください。
プロジェクト は、issue と強く統合されています。 すべての issue メタデータをプロジェクトで使用できるため、作業を表すビューとフィルターを作成できます。 「Projects について」を参照してください。
最新の状態に保つ
Issueの最新のコメントの情報を得ておきたい場合には、Issueをサブスクライブして最新のコメントに関する通知を受け取ることができます。 サブスクライブした Issue の最新の更新へのリンクを素早く見つけるには、ダッシュボードにアクセスしてください。 詳細については、「通知について」および「パーソナルダッシュボードについて」を参照してください。
自分とチームメイトを問題に割り当てて、問題に取り組んでいるユーザーを明確にし、問題を見つけやすくすることができます。 「GitHub の他のユーザに Issue およびプルリクエストをアサインする」および「すべての Issue およびPull Requestを見る」を参照してください。
コミュニティの管理
必要な情報を提供する意味のある issue を共同作成者がオープンしやすくするためには、issue テンプレートが使用できます。 「テンプレートを使用して便利な Issue やプルリクエストを推進する」を参照してください。
効率的なコミュニケーション
コメントに注意を惹きつけるために、issue 内でリポジトリにアクセスできるコラボレーターを @mention できます。 同じリポジトリ内の関連する Issue をリンクするために、# の後に Issue のタイトルの一部を続け、リンクする Issue をクリックできます。 責任を伝えるために、Issueを割り当てることができます。 同じコメントを頻繁に入力しているなら、返信テンプレートを利用できます。
Issueとディスカッションの比較
会話の中には、GitHub Discussionsに適しているものもあります。 GitHub Discussions を使用すると、質問、質問への回答、情報の共有、発表、および製品に関する会話や会話への参加を行うことができます。 詳しくは、「ディスカッションについて」を参照してください。issue またはディスカッションを使うべきときのガイダンスについては、「GitHub でのコミュニケーション」をご覧ください。
issue 内の会話がディスカッションにより適している場合は、issue をディスカッションに変換できます。