4 ms·
In Git, at least, some commands expect the first line of the commit message to be meaningful and self-contained. For example, `git log --oneline`. Following t
by draebek 16y ago
In Git, at least, some commands expect the first line of the commit message to be meaningful and self-contained. For example, `git log --oneline`. Following the custom of making the first line a short summary makes some tools more useful. (Emphasis on "short": eighty column width windows are very common.)
- jakevoytko 16y agoIn addition to Git, "first line as a summary" appears in a few other places - for instance, Mercurial's 'log' command prints just the first line by default. Following the guidelines in this Gist helps future-proof your project history against other tools, and helps developers using your code with some conversion tool.