Issueについて

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

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

sub-issue について

Note

issue の種類、sub-issue、および高度な issue の検索は、現在、組織のオプトインパブリックプレビューにあります。詳細を確認し、待機リストに組織を追加するには、「GitHub ブログ」を参照してください。

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

GitHub

との統合について

issue は、GitHub 全体で作業と統合されます。別の issue または pull request の問題に言及すると、pull request でそれらの間に参照が作成され、fixes: などのキーワードを使用すると、関連する issue が自動的に閉じられます。「Pull RequestをIssueにリンクする」を参照してください。

プロジェクトは、issue と強く統合されています。すべての issue メタデータをプロジェクトで使用できるため、作業を表すビューとフィルターを作成できます。「Projects について」を参照してください。

コミュニティの管理

必要な情報を提供する意味のある issue を共同作成者がオープンしやすくするためには、issue フォームと issue テンプレートが使用できます。「テンプレートを使用して便利な Issue やプルリクエストを推進する」を参照してください。

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

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

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

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

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

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