# (developers) Reminder -- git commit message detail

**URL:** <https://forum.ansible.com/t/developers-reminder-git-commit-message-detail/12220>\
**Category:** Ansible Project\
**Created:** [January 20, 2013, 4:18pm UTC](https://forum.ansible.com/t/developers-reminder-git-commit-message-detail/12220 "2013-01-20T16:18:34Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![Michael\_DeHaan](https://avatars.discourse-cdn.com/v4/letter/m/c4cdca/32.png) [@Michael\_DeHaan](https://forum.ansible.com/u/Michael_DeHaan)\
**Post date:** [January 20, 2013, 4:18pm UTC](https://forum.ansible.com/t/developers-reminder-git-commit-message-detail/12220/1 "2013-01-20T16:18:34Z")

</div>

I'm in the process of compiling the changelog from the git commits,  
which is basically how we know what to document things that have  
changed in each release.

In doing so, it's evident in a few places we all need to be providing  
better commit messages.

So, rather than say "added some new things", a really good commit  
message is "added new options xyz\_foo and xyz\_bar to the foo module,  
and here is an example of how they are used".

In short, if you are in the habit of using "git commit -m", actually  
spawning the editor (vim/emacs/etc) by leaving off the "-m" and typing  
a couple of sentences is a good idea.

This makes it easier when writing documents or browing the history,  
and also keeping up with the pace of development.

Thanks!!!

--Michael