[Nfd-dev] Contributing guide: should commit messages start with upper case or lower case?
Nicholas Gordon
nmgordon at memphis.edu
Tue Apr 10 14:03:27 PDT 2018
Junxiao,
I just don't think it matters that much. It's just a style preference,
and one that I think only obsessive grammarians could argue about.
Since this is a community of programmers, I am not worried that there
are infiltrated grammarians among us. I don't care whether the commit
message is initially capitalized or not.
--
-Nick
On Tue, 10 Apr 2018 16:46:06 -0400
Junxiao Shi <shijunxiao at email.arizona.edu> wrote:
> Dear folks
>
> I'm reading NFD repository's contributing guide, and I notice an
> inconsistency in "commit messages" section.
> https://github.com/named-data/NFD/blob/43bb2315ea022b9aed7fe7922d7b8d8161cf1bc9/CONTRIBUTING.md#commit-messages
>
> Quote from contributing guide:
>
> Commit messages should:
>
>
> - Be written in an imperative mood. E.g. "Make foo a bar" and not "Foo
> is now a bar"
> - Use the present tense. E.g. "Make foo a bar" and not "Made foo a bar"
>
> To explain, the anatomy of a typical commit message is like this:
>
> docs: write contributing guide and code of conduct
>
>
> refs: #3898
>
> Change-Id: Ife89360305027dba9020f0b298793c1121ae1fd6c
>
>
> The verb in two examples of the first paragraph is written in upper case,
> but the verb in the anatomy example is written in lower case.
> I wonder which one is correct?
>
> Yours, Junxiao
More information about the Nfd-dev
mailing list