GitHubでissueを使う

この記事は何か？

GitHubにはissueというバグやタスクを管理する機能が用意されている。

本記事はGitHubのissue作成、Milestoneによる期限設定、Pull Requestとの紐づけによる自動クローズを行うための手順です。

目次

• issueを作成する
• issueに期限を設定する
• Pull Requestをマージした時にissueを自動でクローズする

issueを作成する

1. 「Issues」タブを開く
2. 「New issue」をクリック
3. 「Create new issue」画面で以下を入力する
   1. 「Add a title」:issueの概要
   2. 「Add a description」:issueの詳細
4. 「Create」をクリック

issueに期限を設定する

Milestoneを設定することでissueに期限を設定できる。

Milestoneを作成する

1. 「Issues」タブを開く
2. 「Milestones」をクリック
3. 「New Milestone」をクリック
4. 「Create milestone」画面で以下を入力する
   1. 「Title」:Milestoneの概要
   2. 「Due date」:Milestoneの期限
   3. 「Description」:Milestoneの詳細
5. 「Create Milestone」をクリック

issueにMilestoneを設定する

1. 「Issues」タブで作成済みのissueを開く
2. 右側サイドバーの「Milestone」をクリック
3. 作成済みのMilestoneを選択する

Pull Requestをマージした時にissueを自動でクローズする

issueとPull Requestを紐づけると、Pull Requestをmainブランチにマージしたときにissueを自動的にクローズすることができる。

1. GitHubでPull Requestを発行する

2. Pull Requestの説明にclose #issue番号のように記載する。

   「close #1」
   

   • closeのほかにfixも使用できる。

3. このPull Requestをmainブランチにマージすると、自動的にissueもクローズされる