Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [kura-dev] Requirements for commit messages
Ahh. Now it is clear.

Thank you Benjamin for the clarification.
For me it is ok, but, just to understand, will we reject a PR with wrong commit message formatting?

Best,
Pier

On 06 Oct 2016, at 08:56, Jens Reimann <jreimann@xxxxxxxxxx> wrote:

Yes! Thanks Benjamin for pointing that out.

Traditionally the first Git line is special and should be separated by an empty line. That first line should be around 50 character in order for tools to work properly. But I think going up to 72 character is still possible. More than 72 characters in the first line or in following lines however will cause troubles for tools, like GitHub, egit or the git command line tools.

I am not suggesting that all commit messages should be the size of a twitter message ;-)

On Wed, Oct 5, 2016 at 8:00 PM, Benjamin Cabé <benjamin@xxxxxxxxxxx> wrote:

Just to clarify Jens’ initial proposition: the limit would be 72 characters *per line*, not a 72-character limit for the whole commit message.

 

Benjamin –

 

De : <kura-dev-bounces@xxxxxxxxxxx> au nom de Jens Reimann <jreimann@xxxxxxxxxx>
Répondre à : Kura Developers mailing list <kura-dev@xxxxxxxxxxx>
Date : mercredi 5 octobre 2016 à 08:05
À : "Merlino, Pierantonio" <Pierantonio.Merlino@eurotech.com>
Cc : Kura Developers mailing list <kura-dev@xxxxxxxxxxx>
Objet : Re: [kura-dev] Requirements for commit messages

 

And why not?

 

On Wed, Oct 5, 2016 at 4:36 PM, Merlino, Pierantonio <Pierantonio.Merlino@eurotech.com> wrote:

Hi,

 

ah, now I understand the meaning of this limitation.

I think that we can suggest to limit the message to 72 character for readability, however it should not be mandatory.

 

Best,

Pier

 

On 05 Oct 2016, at 11:31, Jens Reimann <jreimann@xxxxxxxxxx> wrote:

 

I can show you where the disadvantage is, see the following screenshot at GitHub, content gets hidden:

<git_capped.png>


​
So maybe you can help me understand where the benefit in having a longer then 72 character message is ...

 

On Wed, Oct 5, 2016 at 11:21 AM, Merlino, Pierantonio <Pierantonio.Merlino@eurotech.com> wrote:

Hi,

 

I agree with Amit about the no. of characters. 

For the rest it is OK.

 

Best,

Pier

 

On 05 Oct 2016, at 11:10, Amit Kumar Mondal <admin@xxxxxxxxxxxxxx> wrote:

 

Hi Jens,

 

I agree with the meaningful commit messages but it would be very restrictive to limit the no of characters in commit messages for title and description of your commit messages. I believe we can leave it to the developers provided that they provide a meaningful title and detailed description of commit messages.

 

Thanks and Regards,

 

Amit Kumar Mondal
Phone: +49 176 80815427   Email: admin@xxxxxxxxxxxxxx
Skype: arsenalnerk   GitHub: amitjoy
Blog: blog.amitinside.com



Am 5. Oktober 2016 um 9:36:27 AM, Jens Reimann (jreimann@xxxxxxxxxx) schrieb:

I would like to change the following bullet point in the CONTRIBUTING.md file:

---
* Use descriptive and meaningful commit messages
---

To:

---

* Provide descriptive and meaningful commit messages

  * Let the first line of the commit message be no longer than 50 characters, reference an issue using #123 if relevant

  * Provide a descriptive detail message, referencing additional issues, providing some insight of what you change and what you expect from your change, limit those lines to 72 characters

  * Always provide a descriptive detail, unless your code change is really, really, really simple and self explanatory

---

Let me know what you think.

Cheers

Jens


--
Jens Reimann
Senior Software Engineer / EMEA ENG Middleware
Werner-von-Siemens-Ring 14
85630 Grasbrunn
Germany
phone: +49 89 2050 71286
_____________________________________________________________________________

Red Hat GmbH, www.de.redhat.com,
Registered seat: Grasbrunn, Commercial register: Amtsgericht Muenchen, HRB 153243,
Managing Directors: Paul Argiry, Charles Cachera, Michael Cunningham, Michael O'Neill
_______________________________________________ 
kura-dev mailing list 
kura-dev@xxxxxxxxxxx 
To change your delivery options, retrieve your password, or unsubscribe from this list, visit 
https://dev.eclipse.org/mailman/listinfo/kura-dev

_______________________________________________
kura-dev mailing list
kura-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/kura-dev

 




--

Jens Reimann
Senior Software Engineer / EMEA ENG Middleware
Werner-von-Siemens-Ring 14
85630 Grasbrunn
Germany
phone: +49 89 2050 71286
_____________________________________________________________________________

Red Hat GmbH, www.de.redhat.com,
Registered seat: Grasbrunn, Commercial register: Amtsgericht Muenchen, HRB 153243,
Managing Directors: Paul Argiry, Charles Cachera, Michael Cunningham, Michael O'Neill

 




--

Jens Reimann
Senior Software Engineer / EMEA ENG Middleware
Werner-von-Siemens-Ring 14
85630 Grasbrunn
Germany
phone: +49 89 2050 71286
_____________________________________________________________________________

Red Hat GmbH, www.de.redhat.com,
Registered seat: Grasbrunn, Commercial register: Amtsgericht Muenchen, HRB 153243,
Managing Directors: Paul Argiry, Charles Cachera, Michael Cunningham, Michael O'Neill

_______________________________________________ kura-dev mailing list kura-dev@xxxxxxxxxxx To change your delivery options, retrieve your password, or unsubscribe from this list, visit https://dev.eclipse.org/mailman/listinfo/kura-dev


_______________________________________________
kura-dev mailing list
kura-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/kura-dev



--
Jens Reimann
Senior Software Engineer / EMEA ENG Middleware
Werner-von-Siemens-Ring 14
85630 Grasbrunn
Germany
phone: +49 89 2050 71286
_____________________________________________________________________________

Red Hat GmbH, www.de.redhat.com,
Registered seat: Grasbrunn, Commercial register: Amtsgericht Muenchen, HRB 153243,
Managing Directors: Paul Argiry, Charles Cachera, Michael Cunningham, Michael O'Neill
_______________________________________________
kura-dev mailing list
kura-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/kura-dev

Back to the top