ブックマーク / qiita.com/suzuki-hoge (2)

  • コミットは作業ログではない! - Qiita

    いきなりだけど、こんなコミット、よく見ない? (例1とする) 見た瞬間に腕まくりして修正依頼と理由を書き出したくなっちゃう感じ! これが良くない理由を、持論だけど挙げてみるよ このコミットについて コミットは作業単位でするものではない プルリクエスト(以下 PR)をレビューする側に立って考えるとよくわかるのだけど、 PRレビューをする人が欲しているのは(= masterブランチが欲している、チームが欲していると言っても良い)作業者の作業ログではない。 レビューする人にとって、そのPR作成者が「どれくらいの時間をかけた」とか「休日もコミットを重ねてた」とか 「何ファイルも直さなくちゃあならなくて大変だった」とか「いつどこでブランチを切り換えて自分の出したPRを見てくれていた」とか、 そんなことはぶっちゃけ全く興味がないんだ。 欲しいのは「生成物と成果」であって、それを「どの様な作業工程」で作

    コミットは作業ログではない! - Qiita
    tmatsuu
    tmatsuu 2017/02/26
    作業ログとしてコミットしてもいいと個人的には思う。PRする際にそのような作業ログはsquashすると良い。逆に作業ログ以外はsquashするべからず。きれいなPRを心がけたい。
  • コードに仕様書パスをコメントで書くのやめようよ - Qiita

    (まず追記) 自分たちで新たに作成する仕様書はMarkdownで記述してGitHubで管理しています。 こんなのも書いたくらいだし、そこは犯していないです。GitHubを中心とした開発プロセス ドキュメント管理 この記事内で言う仕様書とは、「エクセルで作られて共有サーバに置いてあるチーム管理外のファイル」を指します。 こーゆーの、良くあるよね? public class FooService { /** * 仕様書:ad.xxx.net/development/lorem/ipsum/dolor/sit/amet/consectetur/adipiscing/elit/sed/do/eiusmod/tempor * incididunt_2.xlsx */ public void apply() { } } 見た瞬間「_2.xlsxってなんだよォ...このパス絶対古いんじゃあねェのー?」っ

    コードに仕様書パスをコメントで書くのやめようよ - Qiita
    tmatsuu
    tmatsuu 2017/01/22
    でもそれ、コンパイルした成果物に仕様書情報が埋め込まれて るからぶっこ抜かれる可能性を考えるともにょる気がする。社外に提供されないプログラムならいいけども。
  • 1