<div dir="ltr">Hey all -<div><br></div><div>Per a discussion had on this mailing list [1], I've gone ahead and updated our commit message guidelines [2] to include that the affect subsystems should be listed in the commit message summary when possible:</div>
<div><br></div><div>app_foo: Fix crash when widget is frobbed</div><div><br></div><div>(Or something along those lines)</div><div><br></div><div>Obviously, there may be cases where it is difficult to provide all affected subsystems (documentation changes that span many modules, whitespace cleanup, etc.) - so this is a suggestion, and not mandatory. Use common sense when applying it.</div>
<div><br></div><div>In addition, as time has gone on, we as a project depend more and more on good, well written commit messages. This is for two reasons:</div><div><br></div><div>(1) We have a lot of scripts for release summaries, announcements, JIRA, Review Board, and other tools that look at the commit messages to know what was fixed, what should be closed, etc. Proper commit message formatting is essential for all of these tools to work in a painless fashion. When these tools don't work, the burden is on the developer to 'clean up' after their work - and that's not much fun.</div>
<div><br></div><div>(2) More importantly, as the Asterisk project continues and new developers join, their only view into why a change was made is the commit history. Often, developers who made the original change are no longer active in the project or cannot remember why the change were made! Having proper commit messages is essential to preventing regressions and the continued success of the project.</div>
<div><br></div><div>As such, I've added a little bit of teeth to the commit message guidelines. Repeated, flagrant abuses of the commit message guidelines can result in suspension of your commit access. While we've never had to do this - and I can't think of anyone today who does not write good commit messages - I do think it is important to emphasize how critical good commit messages are to the project. A developer who patches Asterisk with a bad commit message does a disservice to their own work and to the project as a whole - and we should, as a community of developers, not allow that.</div>
<div><br></div><div style>Happy committing everyone!</div><div><br></div><div>[1] <a href="http://lists.digium.com/pipermail/asterisk-dev/2013-October/063203.html">http://lists.digium.com/pipermail/asterisk-dev/2013-October/063203.html</a></div>
<div><br></div><div>[2] <a href="https://wiki.asterisk.org/wiki/display/AST/Commit+Messages">https://wiki.asterisk.org/wiki/display/AST/Commit+Messages</a><br clear="all"><div><br></div>-- <br><div dir="ltr"><div>Matthew Jordan<br>
</div><div>Digium, Inc. | Engineering Manager</div><div>445 Jan Davis Drive NW - Huntsville, AL 35806 - USA</div><div>Check us out at: <a href="http://digium.com" target="_blank">http://digium.com</a> & <a href="http://asterisk.org" target="_blank">http://asterisk.org</a></div>
</div>
</div></div>