Coffee Breakにプログラミング備忘録
From the daily archives: 日曜日, 1月 18, 2015
WIP PR(Work In Progress Pull Request)の運用フロー（作業見える化）をメモ
コードレビューを最適化できるWIP PRについてメモしておく
WIPとは
WIPは作業途中(Work In Progress)という意味がある。通例としてgit上でwipといれたcommitを見かけた場合は、まだ作業途中という目印として使われる。一般的にcommit履歴が汚れるを嫌がり、ローカルではwipは合ってもサーバにはwipは上がらないようにする場合が多い。
※pull requestでwipがcommitメッセージについているのは基本ありえない。作業途中なcommitはpull requestしない。
WIP PR運用フロー
通常pull requestをすることがないwip状態のcommitをpull requestする考え方の運用フロー。
開発のフローとしてチーム全員の作業状況が分かり且つレビューワーは暇しない作業フローになる。
レビューワーは仕上がったpull requestを待つ事なく作業途中の過程を見る事ができるため戻り発生を減らす事に有効
これから作業をする場合に、事前にpull requestを作成して送る場合、gitは基本変更が合った場合にcommitを行うため、何も変更がない場合、commitもpull requestも行わない。
「変更がない」状態の空のcommitを作る事がgitではできるようになっているので、これから作業しようとしている内容をcommitメッセージに含めてcommit / pull requestを行うことで、wipのprフローを開始できる。
WIP PR運用フロー手順1(空のbranchを作成し作成したbranchへ移動する)
次の作業が分かりやすいブランチ名にしておく
git checkout -b feature/fizzbuzz
※masterのコピーとしておく
WIP PR運用フロー手順2(空のコミットを作成する)
commitメッセージはcommitの中身が分かる内容で。
git commit --allow-empty -m "fizzbuzz feature"
WIP PR運用フロー手順3(空のcommitをpushする)
git push origin feature/fizzbuzz:feature/fizzbuzz
WIP PR運用フロー手順4(pull requestする)
commitメッセージには通例[WIP]を入れておく
git pull-request -m "[WIP] fizzbuzz feature" -b upstream:master -h origin:feature/fizzbuzz
※hubコマンドが入っていない場合はgithubのブラウザ上からpull request
hubコマンドを使ってpull requestのコマンド
http://to-developer.com/blog/?p=1372
ここまでで空のwipをpull requestはOK
WIP PR運用フロー手順5(新規commitを更新する)
一旦作業が進んだら細かくコミットしてpushしておく
touch fizzbuzz.rb git add fizzbuzz.rb git commit --amend git push origin feature/fizzbuzz:feature/fizzbuzz
※commitオプションの–amendで以前のcommitを更新するとcommit履歴が汚くならない
これの繰り返しを行うことでレビューがシンプルに！
・・・・wip ・・・to be continued
githubに「pull request」を送れたりするhubコマンドを導入方法をメモ
hubコマンドはGitHub社が公開しており、githubに関する様々な処理をコマンドで実行する事ができるもの。
gitコマンドで既にできることを、シンプルなコマンドで解決したり、gitコマンドではないpull requestなどをコマンドで行う事ができるようになる。
※ 通常はgithubのブラウザからpull requestをする
またhubはgitコマンドを包括しており、hubコマンドでgitコマンドを全て使用することができるようになる。
hubのupstreamリポジトリのreadmeでインストールからコマンドの使い方まで載せているので参考にするとよい。
hubコマンドのリポジトリ：
https://github.com/github/hub
今回はmacでパッケージ管理はhomebrewを使用する
インストール
インストール
brew install --HEAD hub
設定
既存のgitコマンドは全てhubに置き換えられるようになる。
つまりは
git add .
は
hub add .
で、できるようになるが、慣れないためhubコマンドもgitコマンドで使えるようにalias設定をしておく
これはhubのreadmeに記載されている
シェルの設定ファイル：
eval "$(hub alias -s)"
※bashの場合は.bash_profile、zshの場合は、.zprofile
hubの使い方(git clone)
git cloneコマンドについてreadmeより、
git clone $ git clone schacon/ticgit > git clone git://github.com/schacon/ticgit.git $ git clone -p schacon/ticgit > git clone git@github.com:schacon/ticgit.git $ git clone resque > git clone git@github.com/YOUR_USER/resque.git
※gitはalias設定のhubをコールしているため、hubとしても動く
git cloneを行う場合にgithubのリポジトリ指定をなしにしてリポジトリ名のみで取得ができる。またはユーザ名の指定などもできるサンプル
これ以外にも省略できるコマンドはreadme参照
hubコマンドでpull request
git pull-requestコマンドについてreadmeより
# while on a topic branch called "feature": $ git pull-request [ opens text editor to edit title & body for the request ] [ opened pull request on GitHub for "YOUR_USER:feature" ] # explicit title, pull base & head: $ git pull-request -m "Implemented feature X" -b defunkt:master -h mislav:feature
オプションについて
-m : pull requestメッセージ
-b : プルリク先の指定
-h : プルリク元の指定
下記はつまり、メッセージが「Implemented feature X」でmislavのfatureブランチからdefunktのmasterブランチへpull requestのサンプルになる
git pull-request -m "Implemented feature X" -b defunkt:master -h mislav:feature
-mを指定しない場合は、指定しているエディターが起動する（commitと同様）ので指定のフォーマットで記載する
指定フォーマット：
[pull requestタイトル]
[改行]
[pull requestメッセージ]
使える便利コマンド
githubをブラウザで開いてリポジトリを参照するコマンド
git browse
githubをブラウザで開いてdiffを参照するコマンド
git compare
git compareコマンドについてreadmeより
$ git compare refactor > open https://github.com/CURRENT_REPO/compare/refactor $ git compare 1.0..1.1 > open https://github.com/CURRENT_REPO/compare/1.0...1.1 $ git compare -u fix > (https://github.com/CURRENT_REPO/compare/fix) $ git compare other-user patch > open https://github.com/other-user/REPO/compare/patch
coffee-break
スタンプ発売中
スプリットカメラ iOS / Android
音声認識で聞いた日付から曜日当てアプリ Android
ソーシャルタイマー Android
スポンサードリンク
スポンサードリンク
