Re: [openstack-dev] [Ironic] detailed git commit messages
On 28/04/14 12:52, Roman Prykhodchenko wrote: > That seems to be reasonable to me. > > Perhaps we should define a more or less formal format for commit > messages? That might > both help newcomers to write them make it easier for us to write > sensible "What's changed" > documents basing on those commit messages. I usually point newcomers to [1] though the whole page is excellent. [1] https://wiki.openstack.org/wiki/GitCommitMessages#Summary_of_GIT_commit_message_structure > > > - Roman > > ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Ironic] detailed git commit messages
That seems to be reasonable to me. Perhaps we should define a more or less formal format for commit messages? That might both help newcomers to write them make it easier for us to write sensible "What's changed" documents basing on those commit messages. - Roman On пн, 28-кві-2014 14:41:58 +0300, Lucas Alvares Gomes wrote: >> We've all been pretty lax about the amount of detail that we put in commit >> messages some times, and I'd like to change that as we start Juno >> development. Why? Well, just imagine that, six months from now, you're going >> to write a document describing *all* the changes in Juno, just based on the >> commit messages... >> >> The git commit message should be a succinct but complete description of the >> changes in your patch set. If you can't summarize the change in a few >> paragraphs, perhaps that's a sign the patch should be split up! So, I'm >> going to start -1'ing patches if I don't think the commit message has enough >> detail in it. I would like to encourage other cores to do the same. >> >> What's "enough" detail? It's subjective, but there are some lengthy and >> detailed guidelines here that everyone should be familiar with :) >> https://wiki.openstack.org/wiki/GitCommitMessages > > Agreed, I think it's important that we start improving our commit messages. > >> >> >> Cheers, >> Devananda >> >> >> (If English isn't your native language, feel free to ask in channel for a >> little help writing the summary.) > > I want to make a point here, the project has many non-native english > speakers right now and, of course, you can expect grammar/spelling > errors from us, so I think we should be a bit flexible about -1'ing > things for these reasons, nobody wants to keep bugging other people > every time he/she needs to write a commit message. > > Also, if a patch is -1'ed for this reason please make sure you also > leave in the comments a suggestion/correction as part of the review, > do not -1 it saying it's wrong without a replacement text. > > Thanks, > Lucas > > ___ > OpenStack-dev mailing list > OpenStack-dev@lists.openstack.org > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev signature.asc Description: OpenPGP digital signature ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Ironic] detailed git commit messages
> We've all been pretty lax about the amount of detail that we put in commit > messages some times, and I'd like to change that as we start Juno > development. Why? Well, just imagine that, six months from now, you're going > to write a document describing *all* the changes in Juno, just based on the > commit messages... > > The git commit message should be a succinct but complete description of the > changes in your patch set. If you can't summarize the change in a few > paragraphs, perhaps that's a sign the patch should be split up! So, I'm > going to start -1'ing patches if I don't think the commit message has enough > detail in it. I would like to encourage other cores to do the same. > > What's "enough" detail? It's subjective, but there are some lengthy and > detailed guidelines here that everyone should be familiar with :) > https://wiki.openstack.org/wiki/GitCommitMessages Agreed, I think it's important that we start improving our commit messages. > > > Cheers, > Devananda > > > (If English isn't your native language, feel free to ask in channel for a > little help writing the summary.) I want to make a point here, the project has many non-native english speakers right now and, of course, you can expect grammar/spelling errors from us, so I think we should be a bit flexible about -1'ing things for these reasons, nobody wants to keep bugging other people every time he/she needs to write a commit message. Also, if a patch is -1'ed for this reason please make sure you also leave in the comments a suggestion/correction as part of the review, do not -1 it saying it's wrong without a replacement text. Thanks, Lucas ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
