Comments on: History as documentation http://blog.ezyang.com/2010/02/history-as-documentation/ Existential Pontification and Generalized Abstract Digressions Sun, 05 Feb 2012 23:02:11 +0000 hourly 1 http://wordpress.org/?v=3.3.1 By: Edward Z. Yang http://blog.ezyang.com/2010/02/history-as-documentation/comment-page-1/#comment-652 Edward Z. Yang Thu, 08 Jul 2010 00:58:33 +0000 http://blog.ezyang.com/?p=439#comment-652 The standard format is a one-line short description, and then a longer description following it. The Git tools will take advantage of this, since there are abbreviated log formats that just take the first line. Beyond that, the format is very dependent on your circumstance. When I am developing something actively to begin with, I will frequently omit the longer commit message, since the changes come quickly and don’t need much thought. If I commit in a codebase with multiple other active developers, I tailor my message to make it clear to them what my change is about with minimal effort. The standard format is a one-line short description, and then a longer description following it. The Git tools will take advantage of this, since there are abbreviated log formats that just take the first line.

Beyond that, the format is very dependent on your circumstance. When I am developing something actively to begin with, I will frequently omit the longer commit message, since the changes come quickly and don’t need much thought. If I commit in a codebase with multiple other active developers, I tailor my message to make it clear to them what my change is about with minimal effort.

]]> By: Anonymous http://blog.ezyang.com/2010/02/history-as-documentation/comment-page-1/#comment-634 Anonymous Sun, 04 Jul 2010 09:35:24 +0000 http://blog.ezyang.com/?p=439#comment-634 Nice tip about descriptive commit messages. Do you have any recommendations for a good format for larger commit messages? Nice tip about descriptive commit messages. Do you have any recommendations for a good format for larger commit messages?

]]> By: Nils Jonsson http://blog.ezyang.com/2010/02/history-as-documentation/comment-page-1/#comment-632 Nils Jonsson Sun, 04 Jul 2010 01:23:41 +0000 http://blog.ezyang.com/?p=439#comment-632 @Anonymous http://book.git-scm.com/4_interactive_rebasing.html @Anonymous http://book.git-scm.com/4_interactive_rebasing.html

]]> By: Anonymous http://blog.ezyang.com/2010/02/history-as-documentation/comment-page-1/#comment-631 Anonymous Sat, 03 Jul 2010 11:58:04 +0000 http://blog.ezyang.com/?p=439#comment-631 What exactly is the "history rewriting" thing you're mentioning in the last paragraph? Is it a Git feature? Anyway, great post as always. Really inspiring. What exactly is the “history rewriting” thing you’re mentioning in the last paragraph? Is it a Git feature?

Anyway, great post as always. Really inspiring.

]]>