7/29~ プチ断食日記をスタート! 毎日更新中!

[ Github ] IssueとPull requestテンプレート機能でレビュー効率を上げる方法

GitHub-logo

 

こんにちは。たなかです。

エンジニアなら必ず触ることになるであろうGitHub。たなかも例に漏れずGitHubでバージョン管理を行なっています。

 

使い始めると見えてくるのが、プロジェクト管理の面倒さ。

毎回Issue書いて、プルリクエスト書いて、Issueクローズしてって面倒ですよね。

 

今回はGitHubでIssue管理・プルリクエストのやりとりをしているプロジェクトの、効率化のためのIssueテンプレート・プルリクエストテンプレートの作成方法をご紹介します。

 

どこにつくるの?

リポジトリ配下に.githubフォルダを作成し、その中にテンプレートファイルをマークダウン形式で作成していきます。

githubフォルダに

ISSUE_TEMPLATE.mdの作成

こちらはIssue作成時に呼び出されるテンプレートです。

参考までにたなかのテンプレートを展開しておきます。


## タスク内容
タスクの内容を記載

## 対応
対応方針など記載

まあ大した内容ではないですが、Issueなんかは結構内容バラバラだったりするんで、フォーマットガチガチにしない方がかえって楽なんですよね。

必要あらば上記を膨らませるような形で編集すると良いかもしれません。

PULL_REQUEST_TEMPLATE.mdの作成

こちらはプルリクエスト作成時に呼び出されるテンプレートです。

これも参考にたなかのものを展開してみます。


## 対応項目
 - 対応項目1
 - 対応項目2

## テスト結果とテスト項目
 - [ 1 ] テスト項目1
 - [ 1 ] テスト項目2
 - [ 1 ] テスト項目3

## 備考
なし


## UI・デザイン変更
なし

UIデザインは変更あれば画像を貼ったりしてレビュアーにわかりやすいようにします。

プルリクくらいのボリュームになってくるとテンプレートもありがたみが出てきますかね。

 

プルリクマージ時にIssueを自動closeするようにする

最後はtipsですが、プルリクがマージされたタイミングで、関連するIssueを自動closeする方法も解説しておきます。

 

プルリクエストに以下のように追記します。

close リポジトリ名/issues/issue番号

さっきのプルリクエストテンプレートに追加するなら

## Issue管理 
close test/issues/1

こんな感じにしておくとよいかもですね。

上記追加することで、プルリクがマージされたタイミングでtestプロジェクトのissue番号1番が自動的にクローズされます。

これでいちいちIssue一覧に戻って該当のものを手動で閉じる必要がなくなりました!らくちん!

まとめ

GitHub-logo

ということで毎日のレビュー生活を快適にするテンプレート作成のご紹介でした。

 

テンプレートを共有しておくと、レビュイーは書くの楽ですし、レビュアーは見るの楽なのでみんな幸せになれるはず。しかも早い。

お手軽にできるので、率先してやっておくとチームのメンバーに喜ばれるかもしれません。

 

以上、今回はここまで。 

参考サイト

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です