Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [platform-dev] Commit messages

The "why" should become clear from the bug description. Obviously it is important in the commit message but the "what" is more important.

All depends on the change obviously but all commits that include a bugnummer should follow the convention. We can improve on the template in the wiki and e.g. require a Why and a What section. Requiring a specific message format forces us in the habit to think about the commit message.  Also, new contributors have clear directions that we value the commit message.

Bug XXXXXX - Functional change in service XYZ

# Why Service XYZ was not functional because things did not happen.

# What
Service XYZ was adjusted to make things happen.
Change-Id: I0000000000000000000000000000000000000000 Signed-off-by: Your Name <your.email@xxxxxxxxxxxx>





On Sat, Oct 24, 2020 at 7:34 PM Thomas Singer <ts-swt@xxxxxxxxxxx> wrote:
I'd rather vote for *why* something has changed.

Tom


On 2020-10-24 16:53, Wim Jongman wrote:
>   In general, I would say that the commit message must clearly explain to
> others what has changed.
>
> On Sat, Oct 24, 2020 at 2:39 PM Alex Blewitt <alex.blewitt@xxxxxxxxx> wrote:
>
>>
>>> On 24 Oct 2020, at 13:12, Wim Jongman <wim.jongman@xxxxxxxxx> wrote:
>>>
>>> Andrey recently pointed out on a couple of commits that commit messages
>> could be better. I agree with that.
>>
>> Do you have specific or generic types of advice of what could be made
>> better about the commit messages?
>>
>> Alex
>>
>> Sent from my iPhone
>> _______________________________________________
>> platform-dev mailing list
>> platform-dev@xxxxxxxxxxx
>> To unsubscribe from this list, visit
>> https://www.eclipse.org/mailman/listinfo/platform-dev
>>
>
>
> _______________________________________________
> platform-dev mailing list
> platform-dev@xxxxxxxxxxx
> To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
>
_______________________________________________
platform-dev mailing list
platform-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev

Back to the top