<div dir="ltr"><div id="inbox-inbox-magicdomid2" class="inbox-inbox-"><span class="inbox-inbox-">Hi devs,</span></div><div id="inbox-inbox-magicdomid3" class="inbox-inbox-"><br></div><div id="inbox-inbox-magicdomid4" class="inbox-inbox-"><span class="inbox-inbox-">I would like to do a little reminder about the bug report titles and commit messages.</span></div><div id="inbox-inbox-magicdomid5" class="inbox-inbox-"><br></div><div id="inbox-inbox-magicdomid6" class="inbox-inbox-"><span class="inbox-inbox-">For bugs:</span></div><div id="inbox-inbox-magicdomid7" class="inbox-inbox-"><span class="inbox-inbox-">The bug report title must shortly tell what the *bug* is, whereas the commit messages must tell what the *fix* does. Sometimes they are not related at all.</span></div><div id="inbox-inbox-magicdomid8" class="inbox-inbox-"><span class="inbox-inbox-">For instance:</span></div><div id="inbox-inbox-magicdomid9" class="inbox-inbox-"><span class="inbox-inbox-">- bug report titles: "Feature X is not working correctly when Y is enabled", "Click on button 'Save' does not save the record", "Saving stuff on screen X does not work", "This script generates error logs", "Mystake is misspelled in this script", "Behaviour X no longer work as expected" etc.</span></div><div id="inbox-inbox-magicdomid10" class="inbox-inbox-"><span class="inbox-inbox-">- commit messages: "Fix Feature X when Y is enabled", "Make sure behaviour is correct when button is clicked", "Remove warnings from this script", "Correct spelling of mistake in this script", "Fix regression on behaviour X" etc.</span></div><div id="inbox-inbox-magicdomid11" class="inbox-inbox-"><br></div><div id="inbox-inbox-magicdomid12" class="inbox-inbox-"><span class="inbox-inbox-">For enhancements / new feature:</span></div><div id="inbox-inbox-magicdomid13" class="inbox-inbox-"><span class="inbox-inbox-">We could have the same title and commit messages in some cases.</span></div><div id="inbox-inbox-magicdomid14" class="inbox-inbox-"><span class="inbox-inbox-">- bug report titles: "Add new awesome feature", "Add the ability to do that", "Code is duplicated in method Koha::Stuff->method"</span></div><div id="inbox-inbox-magicdomid15" class="inbox-inbox-"><span class="inbox-inbox-">- commit messages: "Add new awesome feature", "Add the ability to do that", "Remove code duplication in method Koha::Stuff->method"</span></div><div id="inbox-inbox-magicdomid16" class="inbox-inbox-"><br></div><div id="inbox-inbox-magicdomid83" class="inbox-inbox-ace-line"><span class="inbox-inbox-author-a-fz75z5sz89z9dz68zp3z72zz65z9z84zz88zz83z">Note that "Address comment #42" is a terrible commit message.</span></div><div id="inbox-inbox-magicdomid84" class="inbox-inbox-ace-line"><br></div><div id="inbox-inbox-magicdomid18" class="inbox-inbox-"><span class="inbox-inbox-">Then, I would like to standardize the commit messages a bit.</span></div><div id="inbox-inbox-magicdomid19" class="inbox-inbox-"><span class="inbox-inbox-">We have "Bug 12345 - ", "Bug 12345: ", "Bug 12345"</span></div><div id="inbox-inbox-magicdomid43" class="inbox-inbox-ace-line"><span class="inbox-inbox-">and "[follow-up]", "(follow-up)", "[QA Followup]", etc.</span></div><div id="inbox-inbox-magicdomid22" class="inbox-inbox-"><br></div><div id="inbox-inbox-magicdomid23" class="inbox-inbox-"><span class="inbox-inbox-">I would suggest:</span></div><div id="inbox-inbox-magicdomid24" class="inbox-inbox-"><span class="inbox-inbox-">  "Bug 12345: you commit message"</span></div><div id="inbox-inbox-magicdomid25" class="inbox-inbox-"><span class="inbox-inbox-">And reject any commit messages with only "follow-up" (or whatever how it is written), but accept</span></div><div id="inbox-inbox-magicdomid26" class="inbox-inbox-"><span class="inbox-inbox-">  "Bug 12345: (follow-up) same commit message as before"</span></div><div id="inbox-inbox-magicdomid27" class="inbox-inbox-"><span class="inbox-inbox-">If you forgot something, even if</span></div><div id="inbox-inbox-magicdomid28" class="inbox-inbox-"><span class="inbox-inbox-">  "Bug 12345: (follow-up) This was missing"</span></div><div id="inbox-inbox-magicdomid29" class="inbox-inbox-"><br></div><div id="inbox-inbox-magicdomid30" class="inbox-inbox-"><span class="inbox-inbox-">And QA follow-ups (added by QA team member):</span></div><div id="inbox-inbox-magicdomid31" class="inbox-inbox-"><span class="inbox-inbox-">  "Bug 12345: "(QA follow-up) Add/remove this stuff"</span></div><div id="inbox-inbox-magicdomid32" class="inbox-inbox-"><br></div><div id="inbox-inbox-magicdomid33" class="inbox-inbox-"><span class="inbox-inbox-">I am going to suggest these change during the next dev meetings.</span></div><div id="inbox-inbox-magicdomid34" class="inbox-inbox-"><span class="inbox-inbox-">If accepted I will change the bug report titles and commit messages before the push during few weeks, then ask authors to do it themselves (patches from new contributors will not be rejected for that reason).</span></div><div id="inbox-inbox-magicdomid35" class="inbox-inbox-"><br></div><div id="inbox-inbox-magicdomid36" class="inbox-inbox-"><span class="inbox-inbox-">You should also read or re-read:</span></div><div id="inbox-inbox-magicdomid37" class="inbox-inbox-"><span class="inbox-inbox-url"><a href="https://wiki.koha-community.org/wiki/Bug_Reporting_Guidelines">https://wiki.koha-community.org/wiki/Bug_Reporting_Guidelines</a></span></div><div id="inbox-inbox-magicdomid38" class="inbox-inbox-"><span class="inbox-inbox-url"><a href="https://wiki.koha-community.org/wiki/Commit_messages">https://wiki.koha-community.org/wiki/Commit_messages</a></span></div><div id="inbox-inbox-magicdomid39" class="inbox-inbox-"><br></div><div id="inbox-inbox-magicdomid40" class="inbox-inbox-"><span class="inbox-inbox-">Cheers,</span></div><div id="inbox-inbox-magicdomid41" class="inbox-inbox-"><span class="inbox-inbox-">Jonathan</span></div></div>