HN 日本語サマリー

← 一覧へ戻る
プログラミング

コミットの説明を思考ツールとして使う

Commit description as a thinking tool (yedhu.me)

130 pointsby yedhukrishnan78 コメント

要約

AI時代において、開発者はAIが生成したコードやコミットメッセージの「なぜ」を理解することに課題を感じています。筆者は、コミットの説明を自分で書くことが、コードの変更を振り返り、意思決定を再評価し、変更の理由を深く理解するための思考ツールとなると主張しています。AIがコードを生成しても、その背後にある意図や一時的な決定事項を明確にするためには、人間の記述が不可欠です。

全文翻訳

コミットの説明を思考ツールとして使う

AI時代以前、私は主要な変更に対して(コミットメッセージの本文として)かなり長いコミットの説明を書いていました。下書きと読み返しに5分から10分ほどかかり、重要なことを見落としていないか確認していました。これにはいくつかの理由がありました。

読者が複数の場所を探し回らなくても、すべての有用な情報を含めたかったからです。

変更の「何」を説明したかったのですが、それ以上に「なぜ」を説明することが重要でした。「何」は一般的に自明な変更点を要約するものですが、「なぜ」を説明するための出発点となります。

時には、一人称で書くこともありました。まるで誰かにメッセージを書くかのように、「私はこれを~のために行いました」「私たちは~するまで、これを~しています」といった具合です。そして、なぜそうしたのかを説明することで、他の人、そして最も重要な自分の将来の自分が、なぜその変更を行ったのかを理解しやすくしました。

それは良い訓練でした。単にコミットメッセージと説明を書くだけではありませんでした。書くプロセス自体が、私が書いたコードを振り返るのに役立ちました。コードを読み返し、変更点を要約します。その過程で、決定を再評価する傾向があり、時にはそれが異なる、あるいはより良い変更につながることもありました。

今、私たちはエージェントコーディングの時代にいます。コードからコミットの説明まで、すべてがAIによって書かれています。AIが書いたコードを読むべきか、そしてその可読性がどれほど難しいかについて、大きな議論があります。私が難しいと感じるのは、AIが書いたコミットの説明を読み、理解することです。

エージェントは、自分が行った変更に対してコミットメッセージを書くことができます。しかし、それらは異なるコミュニケーションツールやプロジェクト管理ツールにまたがる完全なコンテキストを持っていない可能性があります。それらの一部はオフラインになっている可能性もあります。AIが「なぜ」の部分を知らない場合、独自の推論を導き出します。私はそれを危険だと感じています。後でそれを読んだとき、実際の理由は全く異なっていたため、意味をなさないかもしれません。

明らかな解決策の一つは、チャットやツールを通じて、エージェントが必要とするすべてのコンテキストを与えることです。これにより、捏造された推論の問題を修正できます。エージェントは「なぜ」を明確に説明できるようになります。

しかし、これはもう一つの問題は解決しません。適切なコンテキストを持つエージェントは、説得力のあるコミットメッセージを書くでしょう。しかし、コードが説明されているとおりに動作するかどうかを検証できるのは、私だけです。そこで、私がやっていることを紹介します。

コミットメッセージと説明は自分で書く。

その理由は以下の通りです。

コミットの説明を自分で書くことは、AIが行った変更を振り返るのに役立ちます。また、すべてが意図したとおりであるかを確認する方法でもあります。もし「なぜ」を説明できないなら、私は自分が理解していないものを出荷していることになり、後で問題が発生した場合に説明したり修正したりするのが難しくなります。古い引用に戻ります。もしそれを説明できないなら、あなたはそれを理解していないのです。コミットの説明は、ここでも思考ツールとして機能します。

「私たちは~するまで、これを~しています」のような一部は、出口基準を持つ一時的な決定です。私たちは出口条件を設定することがありますが、AIはコードや他のツールからはそれを推測できません。なぜなら、それらはあまりにも明白であるため、どこにも書き留められていないことが多いからです。しかし、コミットメッセージを書くことは、その文を完成させることを強制し、将来の読者がその変更を維持すべきかどうかを判断するのに役立ちます。

エージェントはコードと説明を書くことができます。しかし、「なぜ」を書くことによって、あなたが何を出荷しているかを理解しているかどうかがわかります。