Kevin Fenzi wrote: > Saw a nice article on commit messages: > > https://juffalow.com/other/write-good-git-commit-message > > The one big easy thing I liked from it was: > > "A properly formed Git commit subject line should always be able to > complete the following sentence: if applied, this commit will <your > subject line here>" > > I think this might be a good rule of thumb to apply to our commits, at > least in ansible repo. I'm as guilty as the next person on useless > commits, but I'm gonna try and do better. ;) Nice. It's always good to read more on making the most of git. In the hope that it's useful, there's also some good reading in the git documentation as well. Some of it is targeted specifically at the git project, but most of it is generally good advice. In particular: https://git-scm.com/docs/SubmittingPatches.html#describe-changes https://git-scm.com/docs/git-commit#_discussion are both fine guidelines. One of the things I think makes sense for the ansible repo is using the concept of the "area: " prefix for commits. That makes it immediately clear what part of the code is being addressed when perusing the history. For ansible, that's often the name of the role, so commits working on roles/cgit would naturally start with "cgit: ..." It makes reading the git log --oneline output very pleasant. Thanks for sharing the article. With luck, all the infra folks will have a light few weeks with fewer commits than normal and more time spent enjoying the day away from the screen. :) -- Todd ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Telephone, n. An invention of the devil which abrogates some of the advantages of making a disagreeable person keep his distance. -- Ambrose Bierce, "The Devil's Dictionary"
Attachment:
signature.asc
Description: PGP signature
_______________________________________________ infrastructure mailing list -- infrastructure@xxxxxxxxxxxxxxxxxxxxxxx To unsubscribe send an email to infrastructure-leave@xxxxxxxxxxxxxxxxxxxxxxx Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/infrastructure@xxxxxxxxxxxxxxxxxxxxxxx
