Project

Profile

Help

Issue #1321

Updated by bmbouter over 8 years ago

Currently we recommend the old-style "bug number - title" as the only requirement for the contents of a squashed commit message. This is out of date since we now use the commit keyword integration w/ Redmine (see #103). Also it should have a link to the issue/story; I've seen that a lot already by convention. We should also ask users to write a description of their commit as a paragraph style body. This is a common style I see across the Internet. See an "example here":http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html. [example here](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). 

 The fix should describe things similar to "how [how they are done here":http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html. here](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). And also refer the user to the commit keywords (see #103). 

 You probably need to "update [update this section":http://pulp.readthedocs.org/en/2.6-release/dev-guide/contributing/branching.html#commit-messages, section](http://pulp.readthedocs.org/en/2.6-release/dev-guide/contributing/branching.html#commit-messages), and maybe some places on the merging page that reference "commit messages".

Back