Hi Folks,

I feel like commits have definitely improved in the past year, it's
become much more common for a summary of how a problem was fixed to be
in commit messages, yay for us!

Now that I'm back from my (very refreshing) three week vacation, I'm
reading through hundreds of commit messages instead of the more normal
few at a time, and my experience has prompted me to make a request.

It would be really nice if I didn't have to click on bug URLs over and
over again to figure out what general problem was solved by a commit.

I'd like to ask people to include a sentence about what the bug being
solved is, in addition to including a bug number and a summary of the
solution, when committing.  I acknowledge this is extra effort, and
potentially duplication of the title available elsewhere, but I think
it's important to have titles available directly in the email.  There's
a reason we tend to use one sentence titles and one paragraph summaries,
having a useful title and summary all in one place is the most
digestible way to receive information, and it saves the reader time.

I think this an example of the kind of one-to-many communication where
there's a big collective reward for having a culture where individuals
put in the extra effort.

Thanks!
Jeffrey
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

Open Source Applications Foundation "chandler-dev" mailing list
http://lists.osafoundation.org/mailman/listinfo/chandler-dev

Reply via email to