• はてなブックマーク
  • テクノロジー
  • 提言: コミットメッセージの一行目には要求仕様を書け - Qiita
  • Twitterでシェア
  • Facebookでシェア

提言: コミットメッセージの一行目には要求仕様を書け - Qiita

テクノロジー カテゴリーの変更を依頼 記事元:qiita.com/magicant
適切な情報に変更
576 usersがブックマーク コメント82

    記事へのコメント82件

    • 注目コメント
    • 新着コメント
    kazuya030
    kazuya030 同意しかねる / fix と add は違うから fix は削らないで欲しいような気もするんだけど /「どう直したか」より「どのバグを潰したか」の方が重要な場面は多い気がする。少なくとも1行目では。

    2014/05/30 リンク

    その他
    trashtoy
    trashtoy それより Redmine や Backlog など適当な Issue tracking システムと連携させて、コミットログでは関係する課題IDを必ず明記することが大事。コメントがｇｄｇｄでもなんとかなる

    2014/05/30 リンク

    その他
    y-kawaz
    y-kawaz git commit -am "なんか色々やった"; git commit -am "先週やった作業をcommitしわすれてたのでとりあえず全部"; git commit -am "色々バグ潰した"; git commit -am "aaa"

    2014/05/30 リンク

    その他
    kazoo_oo
    kazoo_oo あまり同意しかねる。ある要求仕様に対するバグフィクスが何度あっても同じようなメッセージが並ぶことになる。やたらと具体的な割には、何をしたのかが見えにくい。「どう変えたか」が結局必要なことも多いのでは。

    2014/05/30 リンク

    その他
    localdisk
    localdisk 一番役立つTipsとしては「コミットメッセージは日本語で書け」があります。

    2014/05/30 リンク

    その他
    atsushifx
    atsushifx コメント問題と一緒。WahtやWhyをきちんとかけということ

    2014/05/29 リンク

    その他
    tengo1985
    tengo1985 あんまり賛成でもないかな。OSSでこれをやられるとどれがバグ修正なのか一目で探しにくい。チケットとの関連付けとかGitHubみたいにタグがついてるならいいけど。

    2014/05/30 リンク

    その他
    k-holy
    k-holy コミットの粒度によるし、タスク管理ツールとの連携を前提にするかどうかでも変わってくる。慣習で決まるものでもないでしょう

    2014/05/30 リンク

    その他
    noonworks
    noonworks 「Aにした」のが「Aを実装した」のか「バグってたのをAに直した」かは欲しいことありそうだし最初4文字くらい「Fix:」とか「Add:」とかに分けてあげてもいいんじゃないかな

    2014/05/30 リンク

    その他
    iori_o
    iori_o 主語はプログラムではなく「このコミット」にしている。要求仕様はそれをひとまとめにした pull request に書くようにしている。要求仕様を満たす為にどんなコミットを積んだかわかるようにしておきたい。

    2014/05/30 リンク

    その他
    yoshiko_pg
    yoshiko_pg プログラマが主語じゃなくてプログラムを主語にするといい、ってわかりやすいな

    2016/05/20 リンク

    その他
    takaesu
    takaesu commit log コミットメッセージ

    2014/09/05 リンク

    その他
    airj12
    airj12 「(コミット)メッセージはプログラムを主語とする動詞句で」

    2014/09/05 リンク

    その他
    ham007
    ham007 こんな感じ？？ NG:「xxxしたときに発生する不具合を修正」 / OK:「xxx時にYYY妥当性チェックを実施する」

    2014/09/04 リンク

    その他
    paz3
    paz3 良いコミットメッセージは、そのコミットによってプログラムがどんな要件を満たすのかをプログラムを主語とする動詞句(原形・命令形)で書く。するとFixedやChangedは不要になる／ブコメにFixやAddは必要という意見も。

    2014/06/18 リンク

    その他
    lucky_pool
    lucky_pool 丹精込めて考えたコミットメッセージはどれくらいの頻度かつどんな目的で振り返るのか。そう考えれば、だいたいで分かれば良いんじゃないかな。プルリクのタイトルだったら要求仕様書けば良いけど。

    2014/06/14 リンク

    その他
    masutaka26
    masutaka26 PullReqestのSubjectだったら同意

    2014/06/07 リンク

    その他
    yosuke_furukawa
    yosuke_furukawa いいtips、多分英語の語彙力増やさないとサッと出てこないこともありそうだけど、そういう時はもう日本語で書いても良さ気。

    2014/06/06 リンク

    その他
    tmatsuu
    tmatsuu ようやく読んだ。とても良いと思う。心がけたい。

    2014/06/05 リンク

    その他
    kimutansk
    kimutansk 修正した「内容（この記事で言うと要求）」と、あと実装詳細を書く、がいつもやっている書き方ですかねぇ・・

    2014/06/02 リンク

    その他
    efcl
    efcl gitのコミットメッセージについて。 最近は殆ど https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit この書き方かなー

    2014/06/02 リンク

    その他
    esper
    esper "とりあえずセーブ"ってのを見かけるｗ

    2014/06/01 リンク

    その他
    ledsun
    ledsun 主語を省略するなら受動態を使うといい。 A Login password longer than 20 characters is allowed.

    2014/05/31 リンク

    その他
    ghostbass
    ghostbass 最近は最後の行にチケット番号書いてるけど先頭のほうがいいかな/　gitで日本語メッセージがまともに扱えるようになったの割と最近だからねえ

    2014/05/31 リンク

    その他
    hokorobi
    hokorobi 良いコミットメッセージの頭に Fixed: とか Added: とかをつけて、要件通りに動くようになったのか、要件が追加されたのかは知りたいかな。

    2014/05/31 リンク

    その他
    AmaiSaeta
    AmaiSaeta 機能追加もフィックスも同じメッセージ(の1行目)になるというのはどうかと。 | "changed"程度の長さを問題視するなら、もう日本語で書いた方が良いし、 http://www.sonasphere.com/blog/?p=1319 を参考にするなら恐らく中国語最強。

    2014/05/30 リンク

    その他
    reoring
    reoring たしかに

    2014/05/30 リンク

    その他
    nilab
    nilab git - 提言: コミットメッセージの一行目には要求仕様を書け - Qiita

    2014/05/30 リンク

    その他
    aklaswad
    aklaswad fixは使わないけどaddは使うなあ。ちょっと意識してみよう/うまくsubjectがまとまらない場合、ちゃんと本文で説明するのも大事かと。/関係ないけど本文一行目で「subjectは釣りです」ってやってみたくなった。今度試しにや

    2014/05/30 リンク

    その他
    sgtakeru
    sgtakeru 主語を「プログラマ」から「プログラム」へ。

    2014/05/30 リンク

    その他
    src256
    src256 日本語で…いやなんでもありません。

    2014/05/30 リンク

    その他
    muddydixon
    muddydixon ケースバイケースだけど参考になる

    2014/05/30 リンク

    その他
    hiro_y
    hiro_y 「メッセージは プログラムを主語とする動詞句 で書くべきです。(そして主語はいつもプログラムなので省略します)」

    2014/05/30 リンク

    その他
    poponponpon
    poponponpon 迷ったら日本語で書いちゃえ

    2014/05/30 リンク

    その他
    kool_kreate
    kool_kreate 並んだときのわかりやすさ

    2014/05/30 リンク

    その他
    richard_raw
    richard_raw プログラマーを主語にするな、と。addとかmodifyばっかりになっていて厭なので実践してみます。

    2014/05/30 リンク

    その他
    ilolio
    ilolio "プログラムを主語とする動詞句"で変更を書け。"プログラマを主語にしてメッセージを書く"と情報が薄くなる。

    2014/05/30 リンク

    その他
    hidex7777
    hidex7777 git commit -m "It's rainy today" git commit -m "sleepy... damepo"

    2014/05/30 リンク

    その他
    a_suenami
    a_suenami ブコメは賛否両論。僕は"わからなくもないが全面的同意はしかねる"立場。コミットは開発者同士のコミュニケーション手段なので"要求"じゃなくて"実装詳細"を書いていい。ただ情報量が少ないのはダメという点は同意。

    2014/05/30 リンク

    その他
    iori_o
    iori_o 主語はプログラムではなく「このコミット」にしている。要求仕様はそれをひとまとめにした pull request に書くようにしている。要求仕様を満たす為にどんなコミットを積んだかわかるようにしておきたい。

    2014/05/30 リンク

    その他

    注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています

    アプリのスクリーンショット
    いまの話題をアプリでチェック！
    • バナー広告なし
    • ミュート機能あり
    • ダークモード搭載
    アプリをダウンロード

    関連記事

    提言: コミットメッセージの一行目には要求仕様を書け - Qiita

    これは Git (や Subversion などのバージョン管理システム) にコミットする時により良いコミットメッセ...

    ブックマークしたユーザー

    • techtech05212023/11/14 techtech0521
    • n0dam12023/05/09 n0dam1
    • kitokitoki2019/10/28 kitokitoki
    • sgwr11292019/08/22 sgwr1129
    • ish1r0k12017/09/20 ish1r0k1
    • michael262017/06/04 michael26
    • potato4d2016/11/27 potato4d
    • johshisha2016/09/07 johshisha
    • yutaka_kinjyo2016/07/26 yutaka_kinjyo
    • atm_09_td2016/06/13 atm_09_td
    • yukung2016/06/12 yukung
    • ariteku2016/06/09 ariteku
    • e5x02016/05/30 e5x0
    • dieth2016/05/30 dieth
    • melchocolate2016/05/30 melchocolate
    • k2k2monta2016/05/30 k2k2monta
    • horikoshijiro2016/05/30 horikoshijiro
    • st2one2016/05/30 st2one
    すべてのユーザーの
    詳細を表示します

    同じサイトの新着

    同じサイトの新着をもっと読む

    いま人気の記事

    いま人気の記事をもっと読む

    いま人気の記事 - テクノロジー

    いま人気の記事 - テクノロジーをもっと読む

    新着記事 - テクノロジー

    新着記事 - テクノロジーをもっと読む

    同時期にブックマークされた記事

    はてなブックマーク

    公式Twitter

    はてなのサービス

    • App Storeからダウンロード
    • Google Playで手に入れよう
    Copyright © 2005-2024 Hatena. All Rights Reserved.