+1 Mathieu for documenting these rules/conventions, thank you! Best regards, Swapnil M Mane, ofbiz.apache.org
On Sun, Sep 29, 2019 at 5:08 PM Mathieu Lirzin <[email protected]> wrote: > Hello, > > Pierre Smits <[email protected]> writes: > > > Fyi: improvement (tickets) get ‘implemented’, and bugs get ‘fixed’. As > per > > established conventions. > > From what I understood from the examples and common practice [1], this > is only partially true. Improvement tickets can be associated with both > ‘Implemented:’ and ‘Improved:’ commits depending on the type of > improvement: > > - Refactoring => “Improved:” > - New feature => “Implemented:” > > [1] > https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template > > > On Sat, 28 Sep 2019 at 15:50 Swapnil M Mane <[email protected]> > wrote: > > > >> Hi Deepak, > >> > >> Happy to see your commits in action. :) > >> Just a minor suggestion, we put Jira ticket ID in separate line in > commit > >> log. > >> Also, add colon ':' in Thanks statement. > >> And since the ticket type is 'Improvement', it seems to me, we should > use > >> 'Improved' instead of 'Fixed'. > >> > >> Here is commit template for your quick reference > >> > >> > https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template > >> > >> Following commit log template will help us in producing the monthly blog > >> development details. > > As a general rule, I would say that working on a “bug” ticket implies at > least one “Fixed:” commit, but it is possible to associate a > complementary refactoring “Improved:” commit to a “bug” ticket. On the > other hand an “improvement” ticket can not be associated with a “Fixed:” > commit. > > What about adding a CONTRIBUTING.adoc file the repository stating those > rules? This would make things far more visible and explicit than on > Confluence which is not very visible (I often to keep bookmarks to > retrieve some information) and far from the code. > > What do people think? > > -- > Mathieu Lirzin > GPG: F2A3 8D7E EB2B 6640 5761 070D 0ADE E100 9460 4D37 >
