GitHub Issueのクイックスタート

はじめに

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

必要な環境

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

空のIssueのオープン

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

1. GitHub Enterprise Serverインスタンスで、リポジトリのメインページにアクセスしてく� さい。
2. リポジトリ名の下で、クリックします Issues

1. [New Issue] をクリックします。
2. この例では、空のIssueから始めます。 リポジトリでは、コントリビューターが特定の情� �を提供することを促進するためにIssueテンプレートが使われるかもしれません。 リポジトリがIssueテンプレートを使うなら、Open a blank Issue（空のIssueをオープン）をクリックしてく� さい。

情� �の記入

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

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

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

タスクリストの追� 

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

ラベルの追� 

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

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

マイルストーンの追� 

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

Issueのアサイン

責任をやりとりするために、IssueをOrganizatoinのメンバーにアサインできます。 詳しい情� �については、「GitHub の他のユーザに Issue およびプルリクエストをアサインする」を参照してく� さい。

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

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

Issueのサブミット

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

コミュニケーション

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

次のステップ

Issueは、幅広い目的で使用できます。 例:

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

GitHubのIssue で次のステップに進む際に役立つ、以下のようなリソースを参照してく� さい。

• Issueについてさらに学ぶには「Issueについて」を参照してく� さい。
• プロジェクトが計画と追跡にどのように役立つかをさらに学ぶには、「プロジェクトボードでの作業の整理」を参照してく� さい。
• Issueテンプレートを利用して、コントリビューターが特定の情� �を提供してくれるよう促進することについてさらに学ぶには「IssueやPull Requestが役立つものになるよう促進するためのテンプレートの利用」を参照してく� さい。