[Nfd-dev] Contributing guide: should commit messages start with upper case or lower case?

Davide Pesavento davide.pesavento at lip6.fr
Tue Apr 10 14:01:47 PDT 2018


On Tue, Apr 10, 2018 at 4:46 PM, 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?

It doesn't matter...

Davide


More information about the Nfd-dev mailing list