Index: include/asterisk/doxygen/commits.h =================================================================== --- include/asterisk/doxygen/commits.h (revision 251939) +++ include/asterisk/doxygen/commits.h (working copy) @@ -47,6 +47,20 @@ * paragraphs, itemized lists, etc. Always end the first sentence (and any * subsequent sentences) with punctuation. * + * The one line summary of changes should be just that. Remember that in most + * cases this summary will show up in the ChangeLog and should briefly describe + * what is being fixed or added. Examples of inadequate change summaries are: + * + * \arg "Let's not do that again, m'kay?" + * \arg "Feature suggested in #asterisk-dev" + * \arg "Adding braces." + * + * Examples of better change summaries might be: + * + * \arg "Initialize variables in chan_foo so that we build in dev-mode." + * \arg "Add 'bugs fix all' CLI command which automatically fixes everything." + * \arg "Resolve logical in res_blah that caused a memory leak." + * * Commit messages should be wrapped at 80 %columns. * * \note For trivial commits, such as "fix the build", or "fix spelling mistake",