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

I suggest googling for "git 50/72" ... there are a bunch of reason to limit this.

Browsing through the Kura repository you find all kinds of commit entries which get capped at (i think 72 character) and just end in the middle of sentence with "…" Reading through a list of changes is really hard.

So I would suggest to follow the rest of the Git world and adopt that rule.

Cheers

Jens

On Wed, Oct 5, 2016 at 11:10 AM, 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



--
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

Back to the top