git-notesでコミットにメモをつける - アジャイルSEの憂鬱

2020年に「コミットログは良くならない」というのを悟ったので、現実的な解決案である「git-notesでメモを残す」について記事を書いておきます。 前回の記事 sinsoku.hatenablog.com git-notes 詳細は git notes --help を読んでください。 概要は以下の通りです。 コミットログとは別にメモを残せる コミットはそのままなのでshaは変わらない shaが変わらないのでCIの再実行が起きない 他人のコミットにメモをつけられる 他人に作業を依頼する必要がない メモもリモートにプッシュできる 過去のコミットにメモを残せる 使い方 メモを書く git notes edit <sha> でメモを書くと、git log のときに一緒に表示される。 $ git notes edit d2cdf0b $ git log -1 d2cdf0b commit d2c

[everybodyelse]

“GitHub はnoteをサポートしていないので、web上で表示する方法は無いです ” うーむ、なるほど。プルリクの機能とうまく統合してくれたら便利そうだなーって思ったんだけどな。

[ymm1x]

標準機能なのか

[tkmkg8m]

情報足りないコミットによく泣かされてるから使おうかな / (追記) よく考えたらコード自体にコメント残したほうが諸々早いので有用な場面は限られるかな？🤔 CIはスキップすればいいし。

[yarumato]

“git-notesは、コミットログとは別にメモを残せる shaが変わらないのでCI再実行起きない 他人のコミットにメモをつけられる 他人に依頼する必要がない メモもリモートにプッシュできる 過去のコミットにメモを残せる”

[masatomo-m]

知らない機能だったけど、CIが常識化した今コミットの変更なしに適用できる機能として見直されていいと思った。GitHubが対応すれば広まりそう

[terazzo]

マージコミットの自動メッセージとかをそのまま残して別にメモつけたり？

[MonMonMon]

知られざる機能だな 初めて知った

[mt_hodaka]

こんな機能あったんか

[daichirata]

コミットの粒度が良くないと良いメモが残せなさそうなので、コミットログがキレイにならないと似た問題がおきそう

[KoshianX]

お、こんな機能が

[satojkovic]

へー、良いこと聞いたわ

[uva]

知らんかった

[Hazel]

これは欲しかった機能。

[tettekete37564]

へえー最近の git なら標準実装されてるんだね。Github で表示もできたらかなり有用そう。コミットハッシュ変わるのが嫌なパターンと push 後に書きたいこと思い出した時とか

[osamu0329]

git本体にこんな機能あったのか。

[hamaco]

知らなかった… 引き継ぎとかで人のコード触る時とか役に立ちそうかも？

[korosuke613]

標準機能なのか..知らなかった。覚えてたらいつか使いどきあるかも

[abcdefghijklmnopqrstuvwxy5]

他人は変わらないから自分が変わるって考え方好き

[shoh8]

へぇこれ知らなかった。使おう git notes

[ken1flan]

これいいな、使おう。。。

[hkawaras]

git notes知らんかった

[hintoku]

これは便利

[hi_yamamoto]

知らんかったヤツ

[hazeblog]

これ良い

[sonots]

こんなものが

[buzztaiki]

一時的なメモみたいな用途でたまに使う。指定すれば push できたのか。

[yoshioka627]

試してみよう

[peketamin]

スバラスィ

[boxshiitake]

知らなかった機能が

[kw5]

こんなのあったんだ

[zentarou]

第三者がメモ追加できるのいいな