[katello-devel] Commit Messages

[Eric D Helms]

I was reading over our Development Process wiki page, and while there are
some out of date items that need cleaning up on it, there is one item that
I wanted to encourage developers to follow. This is a rule of thumb I try
to follow with regards to commit messages that I think helps when reading
through the git log, looking through previous changes or when seeing a pull
request opened up. To quote the page [1]:

"Commit messages should take the form:

Component: Short summary with no more than 70 characters

The next lines of your commit can contain more lines with paragraphs
separated by a blank line in between each paragraph. These should also be
wrapped at 74 or so characters. Why do this? Because it displays better
in git log and on github.

The component is actual user story being worked on. Keep it same for
multiple commits. You can also use dash instead of colon, example:

packagegroups - system test
packagegroups - unit test for CLI
packagegroups - unit test
packagegroups - adding support in CLI
packagegroups - adding support in backend
"

The part of that I think we could benefit more from is the inclusion of the
component name (just like we do bugzilla and github issue numbers to
preface bug fixes) as part of commit messages. For example:

Menu -
Content View Definition -
Comps -
Rel-eng -
API -
Systems -

Ref:
https://fedorahosted.org/katello/wiki/DevProcess#CommitMessages:DescribeYourChanges


- Eric
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/katello-devel/attachments/20130514/a6097ae4/attachment.htm>