http://gwiki3.thatlinuxbox.com/index.php?action=history&feed=atom&title=Commit_Messages 2026-04-05T12:32:18Z Revision history for this page on the wiki MediaWiki 1.27.5 http://gwiki3.thatlinuxbox.com/index.php?title=Commit_Messages&diff=5775&oldid=prev 2010-03-13T13:08:50Z

<p>Some initial guidelines for writing commit messages</p> <p><b>New page</b></p><div>== Writing Good Commit Messages ==<br /> <br /> A commit message should provide a short summary of the change that was made with the commit and why. You should be able to take a look at the [http://project.geeklog.net/cgi-bin/hgwebdir.cgi/geeklog/shortlog list of recent commits] and get an idea what was changed and why.<br /> <br /> === What was changed? ===<br /> <br /> Don't just write &quot;fixed problem&quot;. Summarize the problem and/or the fix. If there is an issue in the bugtracker that you're addressing with this commit (even if only partially), include it in the commit message. For example:<br /> <br /> :Fixed sort by date in search results (bug #0001002)<br /> <br /> This is short and to the point. If you need any more information about the issue, you can look up the bug report in the bugtracker.<br /> <br /> Commit messages should be in English and use &quot;plain ASCII&quot; (no national special characters).<br /> <br /> === Credits ===<br /> <br /> The committer is automatically credited by Mercurial, so there's no need to add your name in the commit message. If you make a commit on somebody else's behalf, e.g. a patch, then include the contributor's name in the commit message, e.g.<br /> <br /> :Send correct content type and character set header in the install script (bug #0000964, patch provided by taca)<br /> <br /> Note: We encourage contributors to send in [[Submitting Patches|patches]] using Mercurial's &lt;tt&gt;export&lt;/tt&gt; command so that they will be listed as the actual author of the patch (instead of the person committing the patch).<br /> <br /> <br /> [[Category:Development]]</div>

Dirk