Ah, I see, misunderstood you intention.I think we can take it as a guideline but at command line and e.g. Eclipse you don't have a character count when committing so that could be a hurdle.
Am 06.09.16 um 12:00 schrieb Taher Alkhateeb:
Hi Michael, I meant a new line after 80 characters. If you review my commit messages that I usually how I do it (I hit the return key and keep on typing). Not a big deal but the output becomes nice on most screens. On Tue, Sep 6, 2016 at 12:55 PM, Michael Brohl <[email protected]> wrote:Taher, I would not put a general limit on the length of the commit message. There are sometimes valuable informations in longer messages I'd like not to miss. Am 06.09.16 um 11:25 schrieb Taher Alkhateeb: +1I also suggest to have maximum width of 80 characters. This makes things nicer and cleaner for svn log On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne < [email protected]> wrote: Hi Michael,I like the idea to have unified commit message format. +1 Thanks for the proposal ! Gil On 06/09/2016 10:08, Michael Brohl wrote: Fellow committers, as you might know, I'm preparing the monthly development details (mostly related to Jiras) for our blog at https://blogs.apache.org/ofbiz/. This is currently a lot of manual work (expecially when we have Community Days!) mostly because the commit messages I use as the source are not unified and written in different formats (Jira reference at the beginning, among the text or end, different line separators, unnecessary or doubled informations like mentioning Jira while also giving the Jira issue etc.). Each developer has his/her own style :-) I'd like to propose a more unified format (or template) for the commit messages which we can put in the Best Practices part of our Wiki. My proposal for a unified format would be: === [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira title|Free text] [(OFBIZ-xxxx)] [Details:] [More detailed explanation of what has been done and what the fix achieves, sideeffects etc.] [Thanks:] [xxxx for ... and yyyy for] === Some rules: * line 1 is mandatory, the following lines are optional * line 1: a ":" follows after the kind of implementation/source of work * line 1: the Jira title must not be quoted (""), the Jira reference should be in parenthesis, no whitespace. * no separators between the lines, just new lines This would help a lot for the preparation of the blog and would also make the reading of the commit logs (command line and IDE) much easier, especially when they are displayed as one-liners. What do you think? Regards, Michael Brohl ecomify GmbH www.ecomify.de
smime.p7s
Description: S/MIME Cryptographic Signature
