[Buildroot] [PATCH 6 of 8] manual: contributing: minor rewording of 'submitting patches' section

Yann E. MORIN yann.morin.1998 at free.fr
Wed Mar 5 17:26:47 UTC 2014


Thomas, All,

Not directly related to your patch...

On 2014-03-05 17:24 +0100, Thomas De Schampheleire spake thusly:
> @@ -236,7 +238,7 @@ Hereafter the recommended layout:
>  ---------------
>  Patch title less than 80-character length
>  
> -Some more paragraph giving some more details.
> +A paragraph giving more details.
>  
>  And yet another paragraph giving more details.

I like it when commit log are describing what the problem is, what the
reason is, and how it is solved. Something like:

    Patch title: short explanation, less than 80 chars

    A paragraph that explains the problem, and how
    it manifests itself. If the problem is complex,
    it is OK to add more paragraph.

    A paragraph that explains the root cause of the problem.
    Again, more than on paragraph is OK.

    Finally, a paragraph than explains how it is solved.
    
    Signed-off-by: John DOE <john.doe at example.net>

Regards,
Yann E. MORIN.

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'


More information about the buildroot mailing list