Rabbit Slide Show

# "uwaaaa"から英文に変わったコミットログを見て自分の書き方をまとめてみた

2013-06-29

Description

tokyurubykaigi06で使用したスライド。 コミットログの自分の書き方について紹介した。 ## 作者向け ### 表示 rake ### 公開 rake publish ## 閲覧者向け ### インストール gem install rabbit-slide-yoshihara-tokyurb06 ### 表示 rabbit rabbit-slide-yoshihara-tokyurb06.gem

Text

Page: 1

"uwaaaa"から英⽂に変
わったコミットログを⾒
て自分の書き⽅をまとめ
てみた
よしはら
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 2

だれ?
✓ よしはら
✓ 吉原 陽⾹
✓ @yshr04hrk
✓ GitHub: yoshihara
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 3

だれ?
✓ 2011/10⽉ぐらい〜
2013/06/28
✓ 株式会社クリアコード
✓ 7⽉から株式会社万葉でバイト
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 4

このLTでしゃべる事
✓ 今昔のコミットメッセージを出
してみる
✓ ×ログ ○メッセージ
✓ 昔と今の間になにがあったか
✓ コミットを書くときに考える事
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 5

昔のコミットメッセージ
✓ 研究時のコミット
✓ 最近いじりなおそうと思った
✓ "uwaaaa"?
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 6

実際
✓ aaaa!
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 7

イマココ!
/(^o^)\
✓ ログだけが頼りだったのに…
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 8

他
✓ delete *.o.
✓ implement get method in 
device driver.
✓ 実は実装してない
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 9

今(最近)
✓ ranguba/packnga
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 10

"uwa(ry"から今までにあっ
たこと
✓ クリアコード正社員
✓ コミットへのコメントを実施
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 11

コミットへのコメント?
1. コミットする
2. メーリングリストにコミットメ
ールが流れる
3. メールでコメントが来る
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 12

つまり
✓ コミットしたらすぐに読まれて
コメントされる
✓ (gkbr)
✓ コミットメッセージ
✓ コミットしたコード(diff)
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 13

どうしたいか
✓ コミットで何をしたのかをコミ
ットだけで伝えたい
✓ 後から説明するの大変
✓ コミットの内容を納得してもら
う
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 14

実際の書き⽅
✓ 1⾏目
✓ 3⾏目以降
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 15

1⾏目
コミットの
「⾒出し」
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 16

3⾏目以降
補⾜情報
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 17

どういうこと?
✓ Q:このコミットは何目的よ?
✓ A:こういう目的のためです
よ。←ココ1⾏目!
というのも... ←ココ3⾏目以降!
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 18

例えば
✓ こんなバグを直したよ!
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 19

例えば
✓ ⾒出し:こんなバグ直したよ!
✓ 補⾜:バグの情報
✓ どういう状況で起きるバグ?
✓ 実際はどうなったらうれしい?
直ったことを納得してもらう
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 20

なぜわかりやすく記録する?
✓ やったことをちゃんと説明した
い
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 21

なぜわかりやすく記録する?
✓ コミットログはプロジェクトを
知るための情報
✓ 開発スタイルや追加された機能
✓ 後から⾒たときの負担を減らす
✓ /(^o^)\防⽌
"uwaaaa"から英⽂に変わったコミットログを⾒て自分の書き⽅をまとめてみた
Powered by Rabbit 2.1.1

Page: 22

ありがとう
ございまし
た

Other slides