On Mon, Sep 8, 2014 at 10:49 AM, Warren Young <war...@etr-usa.com> wrote:

> Sometimes one of my commit messages actually stretches to the point of
> needing paragraphs, either because the problem it fixes is particularly
> complex or because the solution/feature is.


On the problem description side, I use tickets - even for my personal
projects. Doing it for work got me in to the habit. And when I don't use a
ticket, I put the details in the source comments (which may be a better
place, anyway,

On the fix description side, I put any detail commentary in the source
comments and include a reference to the ticket. Even if you are putting the
details in the commit comment, they still need to be in the source comments
where the fix was made. If a fix requires changes in widely separated parts
of the code, I pick one place as the "epicenter" and have the "satellites"
reference that (of course, the satellite comments still need and get
"localized" details).

Almost always, I can keep commit comments down a few lines
_______________________________________________
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Reply via email to