change commit message format to present tense?

classic Classic list List threaded Threaded
25 messages Options
12
Reply | Threaded
Open this post in threaded view
|

change commit message format to present tense?

Tim Graham-2
A few contributors indicated in #django-dev that it could be beneficial to change our commit message format to match git's guidelines of present tense (instead of our current past tense convention) as it would be one less thing to remember when contributing to Django. Besides consistency with the current history, do you feel there are any benefits in continuing to use past tense instead of present tense?

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/1a9e2f05-e10d-42a0-bf28-38b87153aca7%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Carl Meyer-4
On 06/24/2016 10:55 AM, Tim Graham wrote:
> A few contributors indicated in #django-dev that it could be beneficial
> to change our commit message format to match git's guidelines of present
> tense (instead of our current past tense convention) as it would be one
> less thing to remember when contributing to Django. Besides consistency
> with the current history, do you feel there are any benefits in
> continuing to use past tense instead of present tense?

I was one of those contributors in #django-dev. Not only are past-tense
commit messages non-standard for git (meaning they are one more thing a
new contributor is likely to trip over), I also personally find them
harder to write and make clear. Sometimes in a commit message you need
to reference past (pre-commit) behavior and make it clear how the commit
changes that behavior. I occasionally find that harder to do clearly
when the entire commit message is supposed to worded in the past tense.

So I find all the advantages (except for consistency with past history)
in favor of switching to the imperative mood.

Carl

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/576D6702.3080501%40oddbird.net.
For more options, visit https://groups.google.com/d/optout.

signature.asc (836 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Jacob Kaplan-Moss-2
I'm not entirely sure because my memory sucks, but odds are that I started the current standard of using past-tense. 

FWIW I no longer care even at all, I think as long as commit messages are clear we I don't care what tense they are. Following the standard git way seems totally OK to me.

Jacob 

On Fri, Jun 24, 2016 at 10:59 AM, Carl Meyer <[hidden email]> wrote:
On 06/24/2016 10:55 AM, Tim Graham wrote:
> A few contributors indicated in #django-dev that it could be beneficial
> to change our commit message format to match git's guidelines of present
> tense (instead of our current past tense convention) as it would be one
> less thing to remember when contributing to Django. Besides consistency
> with the current history, do you feel there are any benefits in
> continuing to use past tense instead of present tense?

I was one of those contributors in #django-dev. Not only are past-tense
commit messages non-standard for git (meaning they are one more thing a
new contributor is likely to trip over), I also personally find them
harder to write and make clear. Sometimes in a commit message you need
to reference past (pre-commit) behavior and make it clear how the commit
changes that behavior. I occasionally find that harder to do clearly
when the entire commit message is supposed to worded in the past tense.

So I find all the advantages (except for consistency with past history)
in favor of switching to the imperative mood.

Carl

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/576D6702.3080501%40oddbird.net.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CAK8PqJESDrr05-1jJeTbz8UQ%3D%2BJXYHU88w1iGBBnby5czwwVSA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Markus Holtermann
I don't mind either way. If everybody seems to use present tense these
days, yeah, let's do that as well. As long as the general style of the
commit messages stays: Fixes|Refs #12345 -- Make it work

My 2¢

/Markus

On Fri, Jun 24, 2016 at 11:04:39AM -0600, Jacob Kaplan-Moss wrote:

>I'm not entirely sure because my memory sucks, but odds are that I started
>the current standard of using past-tense.
>
>FWIW I no longer care even at all, I think as long as commit messages are
>clear we I don't care what tense they are. Following the standard git way
>seems totally OK to me.
>
>Jacob
>
>On Fri, Jun 24, 2016 at 10:59 AM, Carl Meyer <[hidden email]> wrote:
>
>> On 06/24/2016 10:55 AM, Tim Graham wrote:
>> > A few contributors indicated in #django-dev that it could be beneficial
>> > to change our commit message format to match git's guidelines of present
>> > tense (instead of our current past tense convention) as it would be one
>> > less thing to remember when contributing to Django. Besides consistency
>> > with the current history, do you feel there are any benefits in
>> > continuing to use past tense instead of present tense?
>>
>> I was one of those contributors in #django-dev. Not only are past-tense
>> commit messages non-standard for git (meaning they are one more thing a
>> new contributor is likely to trip over), I also personally find them
>> harder to write and make clear. Sometimes in a commit message you need
>> to reference past (pre-commit) behavior and make it clear how the commit
>> changes that behavior. I occasionally find that harder to do clearly
>> when the entire commit message is supposed to worded in the past tense.
>>
>> So I find all the advantages (except for consistency with past history)
>> in favor of switching to the imperative mood.
>>
>> Carl
>>
>> --
>> You received this message because you are subscribed to the Google Groups
>> "Django developers  (Contributions to Django itself)" group.
>> To unsubscribe from this group and stop receiving emails from it, send an
>> email to [hidden email].
>> To post to this group, send email to [hidden email].
>> Visit this group at https://groups.google.com/group/django-developers.
>> To view this discussion on the web visit
>> https://groups.google.com/d/msgid/django-developers/576D6702.3080501%40oddbird.net
>> .
>> For more options, visit https://groups.google.com/d/optout.
>>
>
>--
>You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
>To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
>To post to this group, send email to [hidden email].
>Visit this group at https://groups.google.com/group/django-developers.
>To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CAK8PqJESDrr05-1jJeTbz8UQ%3D%2BJXYHU88w1iGBBnby5czwwVSA%40mail.gmail.com.
>For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/20160624172521.GF12981%40inel.local.
For more options, visit https://groups.google.com/d/optout.

signature.asc (836 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Tobias McNulty
I'm in support of this as well. Is the suggestion to change the format to:

A) Fixes #12345 -- Add support for ... / Validate that .... / etc.

OR

B) Fixes #12345 -- Adds support for ... / Validates that ... / etc.

OR

C) Something else?

I assume (A) but others may interpret this differently?

On Fri, Jun 24, 2016 at 1:25 PM, Markus Holtermann <[hidden email]> wrote:
I don't mind either way. If everybody seems to use present tense these
days, yeah, let's do that as well. As long as the general style of the
commit messages stays: Fixes|Refs #12345 -- Make it work

My 2¢

/Markus


On Fri, Jun 24, 2016 at 11:04:39AM -0600, Jacob Kaplan-Moss wrote:
I'm not entirely sure because my memory sucks, but odds are that I started
the current standard of using past-tense.

FWIW I no longer care even at all, I think as long as commit messages are
clear we I don't care what tense they are. Following the standard git way
seems totally OK to me.

Jacob

On Fri, Jun 24, 2016 at 10:59 AM, Carl Meyer <[hidden email]> wrote:

On 06/24/2016 10:55 AM, Tim Graham wrote:
> A few contributors indicated in #django-dev that it could be beneficial
> to change our commit message format to match git's guidelines of present
> tense (instead of our current past tense convention) as it would be one
> less thing to remember when contributing to Django. Besides consistency
> with the current history, do you feel there are any benefits in
> continuing to use past tense instead of present tense?

I was one of those contributors in #django-dev. Not only are past-tense
commit messages non-standard for git (meaning they are one more thing a
new contributor is likely to trip over), I also personally find them
harder to write and make clear. Sometimes in a commit message you need
to reference past (pre-commit) behavior and make it clear how the commit
changes that behavior. I occasionally find that harder to do clearly
when the entire commit message is supposed to worded in the past tense.

So I find all the advantages (except for consistency with past history)
in favor of switching to the imperative mood.

Carl

--
You received this message because you are subscribed to the Google Groups
"Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-developers/576D6702.3080501%40oddbird.net
.
For more options, visit https://groups.google.com/d/optout.


--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CAK8PqJESDrr05-1jJeTbz8UQ%3D%2BJXYHU88w1iGBBnby5czwwVSA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/20160624172521.GF12981%40inel.local.

For more options, visit https://groups.google.com/d/optout.



--

Tobias McNulty
Chief Executive Officer

[hidden email]
www.caktusgroup.com

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CAMGFDKQGyJPe%2BnNcsjusPZeMEquPGnobdhp_0pjxXEoJrWtqPQ%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Carl Meyer-4
To be clear, the recommended git style is not present tense, it is
imperative mood. So it should _not_ be "Fixes #12345 -- Regulates the
frobnicator", it should be "Fix #12345 -- Regulate the frobnicator."

Carl

On 06/24/2016 11:45 AM, Tobias McNulty wrote:

> I'm in support of this as well. Is the suggestion to change the format to:
>
> A) Fixes #12345 -- Add support for ... / Validate that .... / etc.
>
> OR
>
> B) Fixes #12345 -- Adds support for ... / Validates that ... / etc.
>
> OR
>
> C) Something else?
>
> I assume (A) but others may interpret this differently?
>
> On Fri, Jun 24, 2016 at 1:25 PM, Markus Holtermann
> <[hidden email] <mailto:[hidden email]>> wrote:
>
>     I don't mind either way. If everybody seems to use present tense these
>     days, yeah, let's do that as well. As long as the general style of the
>     commit messages stays: Fixes|Refs #12345 -- Make it work
>
>     My 2¢
>
>     /Markus
>
>
>     On Fri, Jun 24, 2016 at 11:04:39AM -0600, Jacob Kaplan-Moss wrote:
>
>         I'm not entirely sure because my memory sucks, but odds are that
>         I started
>         the current standard of using past-tense.
>
>         FWIW I no longer care even at all, I think as long as commit
>         messages are
>         clear we I don't care what tense they are. Following the
>         standard git way
>         seems totally OK to me.
>
>         Jacob
>
>         On Fri, Jun 24, 2016 at 10:59 AM, Carl Meyer <[hidden email]
>         <mailto:[hidden email]>> wrote:
>
>             On 06/24/2016 10:55 AM, Tim Graham wrote:
>             > A few contributors indicated in #django-dev that it could
>             be beneficial
>             > to change our commit message format to match git's
>             guidelines of present
>             > tense (instead of our current past tense convention) as it
>             would be one
>             > less thing to remember when contributing to Django.
>             Besides consistency
>             > with the current history, do you feel there are any
>             benefits in
>             > continuing to use past tense instead of present tense?
>
>             I was one of those contributors in #django-dev. Not only are
>             past-tense
>             commit messages non-standard for git (meaning they are one
>             more thing a
>             new contributor is likely to trip over), I also personally
>             find them
>             harder to write and make clear. Sometimes in a commit
>             message you need
>             to reference past (pre-commit) behavior and make it clear
>             how the commit
>             changes that behavior. I occasionally find that harder to do
>             clearly
>             when the entire commit message is supposed to worded in the
>             past tense.
>
>             So I find all the advantages (except for consistency with
>             past history)
>             in favor of switching to the imperative mood.
>
>             Carl
>
>             --
>             You received this message because you are subscribed to the
>             Google Groups
>             "Django developers  (Contributions to Django itself)" group.
>             To unsubscribe from this group and stop receiving emails
>             from it, send an
>             email to [hidden email]
>             <mailto:django-developers%[hidden email]>.
>             To post to this group, send email to
>             [hidden email]
>             <mailto:[hidden email]>.
>             Visit this group at
>             https://groups.google.com/group/django-developers.
>             To view this discussion on the web visit
>             https://groups.google.com/d/msgid/django-developers/576D6702.3080501%40oddbird.net
>             .
>             For more options, visit https://groups.google.com/d/optout.
>
>
>         --
>         You received this message because you are subscribed to the
>         Google Groups "Django developers  (Contributions to Django
>         itself)" group.
>         To unsubscribe from this group and stop receiving emails from
>         it, send an email to
>         [hidden email]
>         <mailto:django-developers%[hidden email]>.
>         To post to this group, send email to
>         [hidden email]
>         <mailto:[hidden email]>.
>         Visit this group at
>         https://groups.google.com/group/django-developers.
>         To view this discussion on the web visit
>         https://groups.google.com/d/msgid/django-developers/CAK8PqJESDrr05-1jJeTbz8UQ%3D%2BJXYHU88w1iGBBnby5czwwVSA%40mail.gmail.com.
>         For more options, visit https://groups.google.com/d/optout.
>
>
>     --
>     You received this message because you are subscribed to the Google
>     Groups "Django developers  (Contributions to Django itself)" group.
>     To unsubscribe from this group and stop receiving emails from it,
>     send an email to [hidden email]
>     <mailto:django-developers%[hidden email]>.
>     To post to this group, send email to
>     [hidden email]
>     <mailto:[hidden email]>.
>     Visit this group at https://groups.google.com/group/django-developers.
>     To view this discussion on the web visit
>     https://groups.google.com/d/msgid/django-developers/20160624172521.GF12981%40inel.local.
>
>     For more options, visit https://groups.google.com/d/optout.
>
>
>
>
> --
>
> *Tobias McNulty
> *Chief Executive Officer
>
> [hidden email] <mailto:[hidden email]>
> www.caktusgroup.com <http://www.caktusgroup.com/>
>
> --
> You received this message because you are subscribed to the Google
> Groups "Django developers (Contributions to Django itself)" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to [hidden email]
> <mailto:[hidden email]>.
> To post to this group, send email to [hidden email]
> <mailto:[hidden email]>.
> Visit this group at https://groups.google.com/group/django-developers.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/django-developers/CAMGFDKQGyJPe%2BnNcsjusPZeMEquPGnobdhp_0pjxXEoJrWtqPQ%40mail.gmail.com
> <https://groups.google.com/d/msgid/django-developers/CAMGFDKQGyJPe%2BnNcsjusPZeMEquPGnobdhp_0pjxXEoJrWtqPQ%40mail.gmail.com?utm_medium=email&utm_source=footer>.
> For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/576D7260.10407%40oddbird.net.
For more options, visit https://groups.google.com/d/optout.

signature.asc (836 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Jon Dufresne
On Fri, Jun 24, 2016 at 10:48 AM, Carl Meyer <[hidden email]> wrote:
To be clear, the recommended git style is not present tense, it is
imperative mood. So it should _not_ be "Fixes #12345 -- Regulates the
frobnicator", it should be "Fix #12345 -- Regulate the frobnicator."

Do you have a link to an authoritative source stating this as the recommended style or is it just common knowledge?

I'm not arguing against the proposal (in fact, I agree with it), I'm just curious if there is documentation to support one style over the other.
 
Cheers,
Jon

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CADhq2b4zz8Dd8%3Dh7PSuMvFOFok3Tn-K0JsQkVkNNiBKphkBH%2Bg%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Marc Tamlyn
This post by Tim Pope is considered the "definitive guide to commit messages" as far as I'm aware.


+1 to adopting this style.

On 24 June 2016 at 19:15, Jon Dufresne <[hidden email]> wrote:
On Fri, Jun 24, 2016 at 10:48 AM, Carl Meyer <[hidden email]> wrote:
To be clear, the recommended git style is not present tense, it is
imperative mood. So it should _not_ be "Fixes #12345 -- Regulates the
frobnicator", it should be "Fix #12345 -- Regulate the frobnicator."

Do you have a link to an authoritative source stating this as the recommended style or is it just common knowledge?

I'm not arguing against the proposal (in fact, I agree with it), I'm just curious if there is documentation to support one style over the other.
 
Cheers,
Jon

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CADhq2b4zz8Dd8%3Dh7PSuMvFOFok3Tn-K0JsQkVkNNiBKphkBH%2Bg%40mail.gmail.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CAMwjO1FMheLWko-f6FvHAVRUTDfTuEbxbJd9yfw3oFfUOTQUQw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Daniele Procida-3
In reply to this post by Jon Dufresne
On Fri, Jun 24, 2016, Jon Dufresne <[hidden email]> wrote:

>On Fri, Jun 24, 2016 at 10:48 AM, Carl Meyer <[hidden email]> wrote:
>
>> To be clear, the recommended git style is not present tense, it is
>> imperative mood. So it should _not_ be "Fixes #12345 -- Regulates the
>> frobnicator", it should be "Fix #12345 -- Regulate the frobnicator."
>>
>
>Do you have a link to an authoritative source stating this as the
>recommended style or is it just common knowledge?
>
>I'm not arguing against the proposal (in fact, I agree with it), I'm just
>curious if there is documentation to support one style over the other.

Lately I keep being recommended <http://chris.beams.io/posts/git-commit/>.

The most compelling reason is that Git itself uses the imperative mood:

    Merge branch ...

    Revert ...

Daniele

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/20160624182329.434459696%40mail.wservices.ch.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Carl Meyer-4
In reply to this post by Jon Dufresne
On 06/24/2016 12:15 PM, Jon Dufresne wrote:

> On Fri, Jun 24, 2016 at 10:48 AM, Carl Meyer <[hidden email]
> <mailto:[hidden email]>> wrote:
>
>     To be clear, the recommended git style is not present tense, it is
>     imperative mood. So it should _not_ be "Fixes #12345 -- Regulates the
>     frobnicator", it should be "Fix #12345 -- Regulate the frobnicator."
>
>
> Do you have a link to an authoritative source stating this as the
> recommended style or is it just common knowledge?
>
> I'm not arguing against the proposal (in fact, I agree with it), I'm
> just curious if there is documentation to support one style over the other.
The style that is most commonly recommended is described in the most
detail (with reasoning) in these blog posts:

http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
http://chris.beams.io/posts/git-commit/

That same style is recommended in the Git Book in
https://git-scm.com/book/ch5-2.html

It is "endorsed" by git itself in that git uses the imperative mood when
it generates a commit message (e.g. for a merge) -- it generates "Merge
branch foo" not "Merges branch foo" or "Merged branch foo."

Also the git project's own commit messages use this style.

Carl




--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/576D7AB0.3040502%40oddbird.net.
For more options, visit https://groups.google.com/d/optout.

signature.asc (836 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Aymeric Augustin
> On 24 Jun 2016, at 20:23, Carl Meyer <[hidden email]> wrote:
>
> The style that is most commonly recommended is described in the most
> detail (with reasoning) in these blog posts:
>
> http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
> http://chris.beams.io/posts/git-commit/

Yes, let’s do that.

Django is the only project I’m aware of that uses the past tense convention.
Keeping doing it differently from everyone else is a sunk cost fallacy.

Also every letter we save is a win when trying to fit in the hilariously short
first line of every commit message.

--
Aymeric.


--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/704C73C4-21B8-4C21-9594-AC217C97C1BD%40polytechnique.org.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Tim Graham-2
With the idea of saving characters in the first line, would "Fix #XXX: Message" be better than ""Fix #XXX -- Message" also? This saves two characters without any loss of readability as far as I see.

On Friday, June 24, 2016 at 4:44:10 PM UTC-4, Aymeric Augustin wrote:
> On 24 Jun 2016, at 20:23, Carl Meyer <<a href="javascript:" target="_blank" gdf-obfuscated-mailto="mEZfqvltAwAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">ca...@...> wrote:
>
> The style that is most commonly recommended is described in the most
> detail (with reasoning) in these blog posts:
>
> <a href="http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html" target="_blank" rel="nofollow" onmousedown="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Ftbaggery.com%2F2008%2F04%2F19%2Fa-note-about-git-commit-messages.html\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNF4-LygmkSEjnNZkLxvWGW-yjAYyQ&#39;;return true;" onclick="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Ftbaggery.com%2F2008%2F04%2F19%2Fa-note-about-git-commit-messages.html\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNF4-LygmkSEjnNZkLxvWGW-yjAYyQ&#39;;return true;">http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
> <a href="http://chris.beams.io/posts/git-commit/" target="_blank" rel="nofollow" onmousedown="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Fchris.beams.io%2Fposts%2Fgit-commit%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFFDT2cBPRY_irLJAkOC1vWfqPiPg&#39;;return true;" onclick="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Fchris.beams.io%2Fposts%2Fgit-commit%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFFDT2cBPRY_irLJAkOC1vWfqPiPg&#39;;return true;">http://chris.beams.io/posts/git-commit/

Yes, let’s do that.

Django is the only project I’m aware of that uses the past tense convention.
Keeping doing it differently from everyone else is a sunk cost fallacy.

Also every letter we save is a win when trying to fit in the hilariously short
first line of every commit message.

--
Aymeric.


--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/942efbfd-70af-4ea0-bc13-2503e9085006%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Carl Meyer-4
On 06/24/2016 03:04 PM, Tim Graham wrote:
> With the idea of saving characters in the first line, would "Fix #XXX:
> Message" be better than ""Fix #XXX -- Message" also? This saves two
> characters without any loss of readability as far as I see.

Seems reasonable to me.

Carl

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/576DA5B8.5090404%40oddbird.net.
For more options, visit https://groups.google.com/d/optout.

signature.asc (836 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Aymeric Augustin
> On 24 Jun 2016, at 23:27, Carl Meyer <[hidden email]> wrote:
>
> On 06/24/2016 03:04 PM, Tim Graham wrote:
>> With the idea of saving characters in the first line, would "Fix #XXX:
>> Message" be better than ""Fix #XXX -- Message" also? This saves two
>> characters without any loss of readability as far as I see.
>
> Seems reasonable to me.

+0

--
Aymeric.

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/9A5B6830-F677-499F-B175-85D3F14929B9%40polytechnique.org.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Reinout van Rees
In reply to this post by Carl Meyer-4
Op 24-06-16 om 19:48 schreef Carl Meyer:
> To be clear, the recommended git style is not present tense, it is
> imperative mood. So it should _not_ be "Fixes #12345 -- Regulates the
> frobnicator", it should be "Fix #12345 -- Regulate the frobnicator."

Everybody seems to be in favour. I'll allow myself a small question mark
anyway.

Why? Well, django is well-known for its excellent documentation. Take
for instance the release notes. Here's a snippet:

"Django now offers password validation to help prevent the usage of weak
passwords by users."

That is how we communicate with our users.

Now back to commit messages and code. Code should be written for humans
reading it, not for computers executing it, right? Readability counts.
Now if I read the history of a file I'd expect to read something that's
pretty readable to me as a developer. I expect to read what happened:

"Added password validation to help prevent the usage of..."


Instead I'll now see commit messages like this:

"Add password validation to prevent the usage of..."

Linguistically, I'm getting an imperative order to do something. And I
have to translate it to a sentence that actually makes sense. Every
django programmer has to make that mental switch/translation.

Is that a cost we want to pay? Does it fit in with our tradition of
providing good documentation? Are we taking linguistic advise from the
people who brought us git's user interface instead of from our English
teachers?

We don't have to order git to do something, we have to communicate what
we've done to fellow programmers.



I'm not a native English speaker, so I might be missing some nuances.
Perhaps it is less weird if you're a native speaker.

Reinout

--
Reinout van Rees                          http://reinout.vanrees.org/
[hidden email]                   http://www.nelen-schuurmans.nl/
"Learning history by destroying artifacts is a time-honored atrocity"

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/nkm456%24qhb%241%40ger.gmane.org.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Shai Berger
In reply to this post by Tim Graham-2
On Saturday 25 June 2016 00:04:30 Tim Graham wrote:
> With the idea of saving characters in the first line, would "Fix #XXX:
> Message" be better than ""Fix #XXX -- Message" also? This saves two
> characters without any loss of readability as far as I see.
>
Is there a real reason for caring either way? Why don't we accept both?

+1 imperative mood.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Tim Graham-2
In reply to this post by Reinout van Rees
Reinout, I agree that the imperative mood seems awkward, especially when reading history, but of course I'm influenced by my experience with Django's history. No doubt others find it more natural. I guess if I had my way, we would keep using past tense, although I will say that it gets a bit tiresome correcting the messages of contributors who don't read our contributing guidelines.

Shai, about "Why don't we accept both?" -- I think it's nice to have a standard format so we don't have to parse visual differences when browsing git log.

On Saturday, June 25, 2016 at 10:23:59 AM UTC-4, Reinout van Rees wrote:
Op 24-06-16 om 19:48 schreef Carl Meyer:
> To be clear, the recommended git style is not present tense, it is
> imperative mood. So it should _not_ be "Fixes #12345 -- Regulates the
> frobnicator", it should be "Fix #12345 -- Regulate the frobnicator."

Everybody seems to be in favour. I'll allow myself a small question mark
anyway.

Why? Well, django is well-known for its excellent documentation. Take
for instance the release notes. Here's a snippet:

"Django now offers password validation to help prevent the usage of weak
passwords by users."

That is how we communicate with our users.

Now back to commit messages and code. Code should be written for humans
reading it, not for computers executing it, right? Readability counts.
Now if I read the history of a file I'd expect to read something that's
pretty readable to me as a developer. I expect to read what happened:

"Added password validation to help prevent the usage of..."


Instead I'll now see commit messages like this:

"Add password validation to prevent the usage of..."

Linguistically, I'm getting an imperative order to do something. And I
have to translate it to a sentence that actually makes sense. Every
django programmer has to make that mental switch/translation.

Is that a cost we want to pay? Does it fit in with our tradition of
providing good documentation? Are we taking linguistic advise from the
people who brought us git's user interface instead of from our English
teachers?

We don't have to order git to do something, we have to communicate what
we've done to fellow programmers.



I'm not a native English speaker, so I might be missing some nuances.
Perhaps it is less weird if you're a native speaker.

Reinout

--
Reinout van Rees                          <a href="http://reinout.vanrees.org/" target="_blank" rel="nofollow" onmousedown="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Freinout.vanrees.org%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHW4i6RGktJexuouw_WtCK12EvJcg&#39;;return true;" onclick="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Freinout.vanrees.org%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHW4i6RGktJexuouw_WtCK12EvJcg&#39;;return true;">http://reinout.vanrees.org/
<a href="javascript:" target="_blank" gdf-obfuscated-mailto="rGT7Kc-nAwAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">rei...@...                   <a href="http://www.nelen-schuurmans.nl/" target="_blank" rel="nofollow" onmousedown="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Fwww.nelen-schuurmans.nl%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNEWM7miskp3svUFyc8QIgI6utIQqg&#39;;return true;" onclick="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Fwww.nelen-schuurmans.nl%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNEWM7miskp3svUFyc8QIgI6utIQqg&#39;;return true;">http://www.nelen-schuurmans.nl/
"Learning history by destroying artifacts is a time-honored atrocity"

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/16e71c88-bdaa-4aed-91fe-4e561c5cc21b%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Kevin Christopher Henry
If anyone's put off by the hectoring tone of the imperative mood, it might be better to think of it as the indicative mood. That is:

(This will) "add password validation to prevent the usage of...".

rather than

(You must) "add password validation to prevent the usage of..."!

In English they're usually expressed the same way, but not so in other languages. Anecdotally, I saw someone comment that in Portuguese the two are different and that the indicative, but not the imperative, would make sense for a commit message. Reinout, I'm curious if that distinction would make a difference in your native language?

For what it's worth, I'm in favor of both proposed changes.

Cheers,
Kevin

On Saturday, June 25, 2016 at 9:29:15 PM UTC-4, Tim Graham wrote:
Reinout, I agree that the imperative mood seems awkward, especially when reading history, but of course I'm influenced by my experience with Django's history. No doubt others find it more natural. I guess if I had my way, we would keep using past tense, although I will say that it gets a bit tiresome correcting the messages of contributors who don't read our contributing guidelines.

Shai, about "Why don't we accept both?" -- I think it's nice to have a standard format so we don't have to parse visual differences when browsing git log.

On Saturday, June 25, 2016 at 10:23:59 AM UTC-4, Reinout van Rees wrote:
Op 24-06-16 om 19:48 schreef Carl Meyer:
> To be clear, the recommended git style is not present tense, it is
> imperative mood. So it should _not_ be "Fixes #12345 -- Regulates the
> frobnicator", it should be "Fix #12345 -- Regulate the frobnicator."

Everybody seems to be in favour. I'll allow myself a small question mark
anyway.

Why? Well, django is well-known for its excellent documentation. Take
for instance the release notes. Here's a snippet:

"Django now offers password validation to help prevent the usage of weak
passwords by users."

That is how we communicate with our users.

Now back to commit messages and code. Code should be written for humans
reading it, not for computers executing it, right? Readability counts.
Now if I read the history of a file I'd expect to read something that's
pretty readable to me as a developer. I expect to read what happened:

"Added password validation to help prevent the usage of..."


Instead I'll now see commit messages like this:

"Add password validation to prevent the usage of..."

Linguistically, I'm getting an imperative order to do something. And I
have to translate it to a sentence that actually makes sense. Every
django programmer has to make that mental switch/translation.

Is that a cost we want to pay? Does it fit in with our tradition of
providing good documentation? Are we taking linguistic advise from the
people who brought us git's user interface instead of from our English
teachers?

We don't have to order git to do something, we have to communicate what
we've done to fellow programmers.



I'm not a native English speaker, so I might be missing some nuances.
Perhaps it is less weird if you're a native speaker.

Reinout

--
Reinout van Rees                          <a href="http://reinout.vanrees.org/" rel="nofollow" target="_blank" onmousedown="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Freinout.vanrees.org%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHW4i6RGktJexuouw_WtCK12EvJcg&#39;;return true;" onclick="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Freinout.vanrees.org%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHW4i6RGktJexuouw_WtCK12EvJcg&#39;;return true;">http://reinout.vanrees.org/
[hidden email]                   <a href="http://www.nelen-schuurmans.nl/" rel="nofollow" target="_blank" onmousedown="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Fwww.nelen-schuurmans.nl%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNEWM7miskp3svUFyc8QIgI6utIQqg&#39;;return true;" onclick="this.href=&#39;http://www.google.com/url?q\x3dhttp%3A%2F%2Fwww.nelen-schuurmans.nl%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNEWM7miskp3svUFyc8QIgI6utIQqg&#39;;return true;">http://www.nelen-schuurmans.nl/
"Learning history by destroying artifacts is a time-honored atrocity"

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/24da9fcf-7a9e-4cde-8af6-8673fdcaebaa%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Reinout van Rees
Op 26-06-16 om 05:31 schreef Kevin Christopher Henry:
> If anyone's put off by the hectoring tone of the imperative mood, it
> might be better to think of it as the indicative mood. That is:
>
> (This will) "add password validation to prevent the usage of...".
>
> rather than
>
> (You must) "add password validation to prevent the usage of..."!

"It might be better to think of it as...": it is exactly this extra
thinkwork that everyone reading the messages has to do. We write it once
and read it many times: what should we optimize for?
In our source code, the answer is clearly that you should optimize for
readability.
Why is it suddenly different for commit messages?

Git will probably be replaced by an even better tool in 5 years' time
(just like svn before that and cvs before): will we go back to the
original proper English then?

> In English they're usually expressed the same way, but not so in other
> languages. Anecdotally, I saw someone comment that in Portuguese the two
> are different and that the indicative, but not the imperative, would
> make sense for a commit message. Reinout, I'm curious if that
> distinction would make a difference in your native language?

In Dutch, the imperative and indicative are different.
But that would be better solved by using the indicative also in English,
right?

- "Adds password validation to prevent..."

The changelog will now look just like installation instructions:

- Install django using `pip install django`.

- Add a database.

- Run `python manage.py ....`





Reinout

--
Reinout van Rees                          http://reinout.vanrees.org/
[hidden email]                   http://www.nelen-schuurmans.nl/
"Learning history by destroying artifacts is a time-honored atrocity"

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/nkqsr9%24oh2%241%40ger.gmane.org.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: change commit message format to present tense?

Riccardo Magliocchetti
Il 27/06/2016 11:49, Reinout van Rees ha scritto:

> Op 26-06-16 om 05:31 schreef Kevin Christopher Henry:
>> If anyone's put off by the hectoring tone of the imperative mood, it
>> might be better to think of it as the indicative mood. That is:
>>
>> (This will) "add password validation to prevent the usage of...".
>>
>> rather than
>>
>> (You must) "add password validation to prevent the usage of..."!
>
> "It might be better to think of it as...": it is exactly this extra thinkwork
> that everyone reading the messages has to do. We write it once and read it many
> times: what should we optimize for?
> In our source code, the answer is clearly that you should optimize for readability.
> Why is it suddenly different for commit messages?

I think you are overthinking here :) just look at django commit history vs the
git or the linux one. Which commit message would you like to when chasing a bug?

They have a far better culture at that to what in my experience have found in
the python ecosystem. So let's just copy that :)

--
Riccardo Magliocchetti
@rmistaken

--
You received this message because you are subscribed to the Google Groups "Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/828d95a7-8a3d-df99-33c0-b27ef8d0add9%40gmail.com.
For more options, visit https://groups.google.com/d/optout.
12