Githubにissueのテンプレートを作成する方法

Githubにはissueのテンプレート機能があるようなので利用してみました。テンプレートを作成することで、複数人数で開発していても issue の書き方が統一できるので便利です。

それでは issue のテンプレート作成方法を説明します。

Githubに issue テンプレートを作成する方法

1. Settingsページへ移動

Githubの 『Settings』 → 『Options』 をクリックします。

2. テンプレート作成画面に移動

画面中程にある Features のIssuesの『Set up templates』をクリックします。

3. テンプレート作成画面に移動

『Add template:select』をクリックし『Custom template』をクリックします。

『Preview and edit』をクリックします。

クリックするとテンプレートが表示されます。タイトル横の鉛筆マークをクリックします。

編集画面が表示されます。

4. テンプレートを作成

『Templata name』と『Template content』を修正します。

完成したら、右上の『Propose changes』をクリックします。

5. コミットする

commit メッセージを記載するフィールドが表示されるので、記載し『Commit changes』をクリックします。

以上で対応完了です。

テンプレート内容確認

・issueの作成画面より確認する

issue作成画面に移動します。

すると、作成したテンプレートが表示されます。

『Get started』をクリックすると、先ほどのテンプレートが利用できます。

以上です。

・ファイルより確認する

『code』より『.github』ディレクトリ内に『ISSUE_TEMPLATE』というディレクトリが作成されています。

『ISSUE_TEMPLATE』ディレクトリ内に、『issue------.md』といファイルが作成されています。こちらがテンプレート内容が記載されたファイルとなります。

以上で確認終了です。

最後に

issueですが

・なんのためにやるのか？
・なぜやらなくてはいけないのか？
・どのように対応するのか？

あたりが書かれていないと、『ん・・・？なんでこのissueやるんだろう？？』みたいに思ってしまうことがあります。
ただ、これを参加メンバーに共有するのは大変だったりしますよね。（メンバーが途中からどんどん参加していくプロジェクトだ特に）

そんな時にテンプレートがあって、その通り作れば良いというルールだけ作っておけて、周知のコストをかけなくてもすんなり参加できるようになるのかなと思います。

また、Githubのプルリクエスト同様、issueについても統一感持って作成された方が、作成する方も考える手間が減り、見る方も見やすくなると思います。

ということで皆さんもテンプレート化利用して見てください。