har0ke/FFmpeg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add example around the suggested commit message format

Browse Source 
It gets rendered inline in HTML and becomes not very clear.

Reviewed-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
This commit is contained in:
James Darnley 2014-09-12 01:31:26 +02:00 committed by Michael Niedermayer
parent 453944cc77
commit e3fb2b0eb7
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/developer.texi
View File

@ -323,9 +323,12 @@ Always fill out the commit log message. Describe in a few lines what you
changed and why. You can refer to mailing list postings if you fix a changed and why. You can refer to mailing list postings if you fix a
particular bug. Comments such as "fixed!" or "Changed it." are unacceptable. particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
Recommended format: Recommended format:
@example
area changed: Short 1 line description area changed: Short 1 line description
details describing what and why and giving references. details describing what and why and giving references.
@end example
@item @item
Make sure the author of the commit is set correctly. (see git commit --author) Make sure the author of the commit is set correctly. (see git commit --author)