GitHub Issueのクイックスタート

はじめに

このガイドは、GitHub Issuesを使って作業の断片を計画及び追跡する方法を示します。このガイドでは、新しいIssueを作成し、タスクリストを追� してサブタスクを追跡します。ラベル、マイルストーン、アサインされた人、プロジェクトを追� して、Issueに関するメタデータをやりとりする方法についても学びます。

前提条件

Issueを作成するにはリポジトリが必要です。書き込みアクセス権を持つ既存のリポジトリを利用することも、新しいリポジトリを作成することもできます。リポジトリはIssueを有効化していなければなりません。リポジトリの作成の詳細については、「新しいリポジトリの作成」を参照してく� さい。リポジトリで無効になっている� �合の Issue の有効化の詳細については、「Issue の無効化」を参照してく� さい。

空のIssueのオープン

まず、Issueを作成してく� さい。 Issueの作成方法は複数あります。自分のワークフローで最も便利な方法を選択できます。この例では、GitHub UIを使用します。 Issue を作成するその他の方法の詳細については、「Issue の作成」を参照してく� さい。

On your GitHub Enterprise Server instance, navigate to the main page of the repository. 2. リポジトリ名の下にある [issue] をクリックします。 1. [New issue](新しい Issue) をクリックします。
この例では、空のIssueから始めます。リポジトリでは、コントリビューターが特定の情� �を提供することを促進するために Issue テンプレートが使用される� �合があります。リポジトリで Issue テンプレートが使用されている� �合は、 [空の Issue をオープン] をクリックします。

情� �の記入

Issueに分かりやすいタイトルを付けてく� さい。このタイトルは、Issueが何に関するものなのかが一目でわかるものにすべきです。

Issueを解決するのに役立つかもしれない詳細情� �も含めて、Issueの目的を記述する説明を追� してく� さい。たとえば、もしそれがバグレポートなら、バグを再現するステップ、期待される結果、実際の結果を記述してく� さい。

フォーマット、リンク、絵文字などを追� するためにMarkdownを使うことができます。詳細については、「GitHub での執筆」を参照してく� さい。

Issueのタイトルと本文

タスクリストの追�

大きなIssueを小さなタスクに分割したり、複数の関連するIssueを1つの大きなIssueで追跡すると役立つことがあります。リスト� �目の前に [ ] を置いて、Issue にタスクリストを追� します。既存のIssueは、Issue番号あるいはURLで参照してく� さい。対応するIssueを持たないタスクを追跡するのにプレーンテキストを使い、それらを後でIssueに変換することができます。詳細については、「タスクリストについて」を参照してく� さい。

タスクリストのあるIssue

ラベルの追�

Issueを分類するために、ラベルを追� してく� さい。たとえば、bug ラベルと good first issue ラベルを使って、Issue が初めてのコントリビューターが取り上げることができるバグであることを示す� �合があります。ユーザは、ラベルを使ってIssueをフィルタリングし、特定のラベルを持つすべてのIssueを見つけることができます。

デフォルトのラベルを使うことも、新しいラベルを作成することもできます。詳細については、ラベルの管理に関する記事を参照してく� さい。

ラベルを持つIssue

マイルストーンの追�

マイルストーンを追� して、Issueを日付ベースのターゲットの一部として追跡できます。マイルストーンは、ターゲットの日に近づくにつれて、Issueの進捗を示します。詳細については、「マイルストーンについて」を参照してく� さい。

マイルストーンを持つIssue

Issueのアサイン

責任をやりとりするために、IssueをOrganizatoinのメンバーにアサインできます。詳細については、他の GitHub ユーザーに Issue と pull request を割り当てる方法に関するページを参照してく� さい。

アサインされた人を持つIssue

プロジェクトへのIssueの追�

issue を既存のプロジェクトに追� してプロジェクトの詳しい情� �については、「プロジェクトボードで作業を整理する」を参照してく� さい。

プロジェクトを持つIssue

Issueのサブミット

[新しい Issue をサブミット] をクリックして、Issue を作成します。上記のフィールドは、いずれもIssueを作成した後に編集できます。 Issueは一意のURLを持ち、それをTeamのメンバーと共有したり、あるいは他のIssueやPull Request内で参照したりできます。

コミュニケーション

Issueを作成した後は、そのIssueにコメントを追� して会話を続けてく� さい。コラボレーターまたはチー� を @mention して、コメントに注意を惹きつけることができます。同じリポジトリ内の関連する Issue をリンクするために、# の後に Issue のタイトルの一部を続け、リンクする Issue をクリックできます。詳細については、「GitHub での執筆」を参照してく� さい。

Issueのコメント

次の手� �

Issueは、幅広い目的で使用できます。たとえば次のような点です。

アイデアの追跡
フィードバックの収集
タスクの計画
バグの� �告

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

Issue の詳細については、「Issue について」を参照してく� さい。
プロジェクトの計画と追跡に役立つ方法の詳細については、「プロジェクトボードで作業を整理する」を参照してく� さい。
Issue テンプレートを使用して、コントリビューターが特定の情� �を提供してくれるように促進することについてさらに学ぶには、「テンプレートを使用して便利な Issue やプルリクエストを推進する」を参照してく� さい。