[libcamera-devel] [PATCH] Documentation: contributing: Add commit message guidelines

[Umang Jain]

Hello,

On 12/12/22 7:08 PM, Kieran Bingham via libcamera-devel wrote:
> Quoting Laurent Pinchart via libcamera-devel (2022-12-12 13:11:38)
>> All developers, whether junior or experienced, can benefit from
>> improving their commit message writing skills. Add a paragraph to the
>> contribution documentation to explain this, with a link to a good guide.
>>
>> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> Sounds good to me.
>
>
> Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>

Seconded,

Reviewed-by: Umang Jain <umang.jain at ideasonboard.com>

>
>> ---
>>   Documentation/contributing.rst | 7 +++++++
>>   1 file changed, 7 insertions(+)
>>
>> diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
>> index 6405c5fb8a1a..2f0b4921f7e6 100644
>> --- a/Documentation/contributing.rst
>> +++ b/Documentation/contributing.rst
>> @@ -68,6 +68,13 @@ code that is as easy to read, understand and maintain as possible. This is
>>   made possible by a set of :ref:`coding-style-guidelines` that all submissions
>>   are expected to follow.
>>   
>> +We also care about the quality of commit messages. A good commit message not
>> +only describes what a commit does, but why it does so. By conveying clear
>> +information about the purpose of the commit, it helps speeding up reviews.
>> +Regardless of whether you're new to git or have years of experience,
>> +https://cbea.ms/git-commit/ is always a good guide to read to improve your
>> +commit message writing skills.
>> +
>>   The patch submission process for libcamera is similar to the Linux kernel, and
>>   goes through the `libcamera-devel`_ mailing list. If you have no previous
>>   experience with ``git-send-email``, or just experience trouble configuring it
>>
>> base-commit: b026e4a6a0a620ce994938c3d1babd3f3df4a47e
>> prerequisite-patch-id: ef2a8b4c18a2688014681a8f75d7ceddaed07b99
>> prerequisite-patch-id: 7b397e1ed4feed4d64faf71370fc3df4a46bb2eb
>> prerequisite-patch-id: b7d57dd39a032a92e05d3d4e22bb821b085e2291
>> prerequisite-patch-id: 05daa092b096bd8385c1ca3587e344570724308d
>> -- 
>> Regards,
>>
>> Laurent Pinchart
>>