The subject can be quite lengthy (as I have experienced a few times when doing PRs). I suggest to moving the ticket Id to the front of the first line. Also, whatever the categorisation is ([Implemented | Improved | Fixed | Completed| Documented | Reverted]: this should be referenced (at least) in the ticket.
While having everything significant (like the categorisation) on the first line is desirable, the minimum is the ticket ID. I don't mind (people) to click through to the ticket to get a better understanding. What are best practices from other (Apache/Open Source) projects? Met vriendelijke groet, Pierre Smits *Proud* *contributor** of* Apache OFBiz <https://ofbiz.apache.org/> since 2008 (without privileges) *Apache Trafodion <https://trafodion.apache.org>, Vice President* *Apache Directory <https://directory.apache.org>, PMC Member* Apache Incubator <https://incubator.apache.org>, committer Apache Steve <https://steve.apache.org>, committer On Wed, May 20, 2020 at 11:03 AM Jacques Le Roux < [email protected]> wrote: > Hi, > > With Git IMO it's convenient (more information) to have the Jira number in > the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t > > If nobody disagree I'd like to modify > > > https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template > > We could have > > ---- > > [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [Jira > title | Free text] [(OFBIZ-xxxx)] > > [(OFBIZ-xxxx)] > > [More detailed explanation of what has been done and what the fix achieves, > sideeffects etc.] > > [Thanks:] [xxxx for ... and yyyy for] > > ---- > > But I would prefer: > ---- > [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [Jira > title | Free text] [(OFBIZ-xxxx)] > > [More detailed explanation of what has been done and what the fix achieves, > sideeffects etc.] > > [Thanks:] [xxxx for ... and yyyy for] > > ---- > Opinions? > > Thanks > > Jacques > >
