Re: Summarizing the purpose of a change.

[Miles Bader]

Karl Fogel <address@hidden> writes:
> In many projects, there is a convention of summarizing the purpose of a
> change in one or two sentences at the start of the log entry.  This makes
> the rest of the log entry (and the change itself) easier to understand.

And if possible, make the summary not "1 or 2" sentences, but a single
not-to-long line, such as you'd use for an email Subject: header.

-Miles

-- 
The automobile has not merely taken over the street, it has dissolved the
living tissue of the city.  Its appetite for space is absolutely insatiable;
moving and parked, it devours urban land, leaving the buildings as mere
islands of habitable space in a sea of dangerous and ugly traffic.
[James Marston Fitch, New York Times, 1 May 1960]