Issueについて

GitHub Issues を使用してアイデア、フィードバック、タスク、バグを追跡する方法を学びます。

この記事の内容

リポジトリに問題を作成して、作業の計画、議論、追跡を行うことができます。 issue は迅速に作成でき、柔軟性があり、さまざまな方法で使用できます。 Issue では、バグ レポート、新機能やアイデア、その他書き留めたりチームで話し合ったりする必要があるものを追跡できます。また、projects を使って、チームの作業を計画および追跡できます。 sub-issue を追加することで作業をさらに細分化し、実行する作業の完全な階層を簡単に閲覧することもできます。

Issueは様々な方法で作成できるので、ワークフローで最も便利な方法を選択できます。 たとえば、sub-issue の追加中にリポジトリ から issue を作成できます。 は、issue またはプル要求のコメントを変換したり、特定のコード行から issue を作成したり、URL クエリを使用して作成したりできます。 Issueは、Web UI、GitHub Desktop、GitHub CLI、GraphQL及びREST API、GitHub Mobileといった好きなプラットフォームから作成することもできます。 「Issue の作成」を参照してください。

ヒント

Copilot Chat を使って、issue に基づいてディスカッションまたはブログ記事のアイデア、アウトライン、または下書きを生成することもできます。 「ディスカッションまたはブログ記事を書く」を参照してください。

sub-issue について

Issue に sub-issue を追加することで、大きな作業を小さな issue にすばやく分割することができます。 sub-issue により、issue 間の関係が作成されて、GitHub での issue の階層のサポートが追加されます。 ユーザーやチームが必要とする詳細さにタスクを分割することでプロジェクトを正確に表す sub-issue の複数のレベルを作成することができます。「sub-issue の追加」と「sub-issue の閲覧」を参照してください。

Issue の依存関係について

Issue の依存関係を使って、issue 間のブロック リレーションシップを定義できます。 Issue の依存関係により、他の作業にブロックされている、またはブロックしている issue を特定できます。 「Issue の依存関係の作成」を参照してください。

Issue のメタデータ

Issue を整理するために、issue の種類、ラベル、マイルストーンなどのメタデータを issue に追加できます。

「組織での 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 やプルリクエストを推進する」を参照してください。

コミュニティを健全に保つために、GitHub のコミュニティ ガイドラインに違反するコメントをレポートできます。 「悪用あるいはスパムをレポートする」を参照してください。

効率的なコミュニケーション

コメントに注意を惹きつけるために、issue 内でリポジトリにアクセスできるコラボレーターを @mention できます。 同じリポジトリ内の関連する Issue をリンクするために、# の後に Issue のタイトルの一部を続け、リンクする Issue をクリックできます。 責任を伝えるために、Issueを割り当てることができます。 同じコメントを頻繁に入力しているなら、返信テンプレートを利用できます。 「基本的な書き方とフォーマットの構文」と「GitHub の他のユーザに Issue およびプルリクエストをアサインする」を参照してください。

Issueとディスカッションの比較

会話の中には、GitHub Discussionsに適しているものもあります。 GitHub Discussions を使用すると、質問、質問への回答、情報の共有、発表、および製品に関する会話や会話への参加を行うことができます。 詳しくは、「ディスカッションについて」をご覧ください。issue またはディスカッションを使うべきときのガイダンスについては、「GitHub でのコミュニケーション」を参照してください。

Issue内での会話にディスカッションの方が適している場合は、Issueをディスカッションに変換できます。

次のステップ

GitHub Issues で次のステップを実行するための役立つリソースを、いくつか次に示します。