継続的ブログ

主にweb系の技術について書いています

Pull Request本文のフォーマットを決めて、そのテンプレートをデフォルト表示

追記
(2015/12/14)こっちの方がいいかもですね。。。
Git のコミットメッセージをテンプレート化する - Qiita

初回の空コミットのコミットメッセージにテンプレートを入れるようにする

うちではWIP PRによる開発運用をしています。
PR本文のフォーマットは特に決まってませんが、

  1. フォーマット決めたらもっと捗るよね!
  2. フォーマットのテンプレート的なものをデフォルトで表示して、そこを埋めていく感じにすれば、より捗るよね!

ということになり、最初に作成する空コミットを、コミットメッセージにテンプレートを付けて作成するシェルを作りました。
そうすれば、PR作った時に、本文にテンプレートが表示されるというわけです。
やってることはかなり単純です。

#!/bin/sh

echo ${1:?"コミットメッセージを入力してください!"}

git commit --allow-empty -F- <<EOF
[WIP] $1

## 概要

## 仕様

## TODO

## その他

EOF
$ sh create_wip_commit.sh hoge機能実装

とりあえずこんな感じで実行して、プッシュ、PRを作成する感じです。
毎回このコマンド実行するのもちょっとダサいので、自分はgit aliasに設定しています。

思いつきでやったので、もっといい方法はありそうだけど。。。
他にいい方法知ってるよって方は教えて下さい!