awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix Markdown issues with contributing guide. 

Inline code blocks (`code`) apparently can not be extended about
multiple lines.

Signed-off-by: Julian Wollrath <jwollrath@web.de>
This commit is contained in:
Julian Wollrath 2015-02-26 17:05:54 +01:00 committed by Daniel Hahler
parent ffa535ca29
commit fcadebb8ae
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/02-contributing.md
View File

@ -64,8 +64,8 @@ One can use the full power of
the comments. the comments.
Every module and class should have a short description at its beginning which Every module and class should have a short description at its beginning which
should include `@author author`, `@copyright year author`, `@release should include `@author author`, `@copyright year author`,
@AWESOME_VERSION@` and `@module module-name` or `@classmod class-name`. `@release @AWESOME_VERSION@` and `@module module-name` or `@classmod class-name`.
Parameters of functions should be documented by `@param parameter description`, Parameters of functions should be documented by `@param parameter description`,
return values via `@return description` or `@treturn type description`. For a return values via `@return description` or `@treturn type description`. For a
more comprehensive description of the available tags see the [LDoc more comprehensive description of the available tags see the [LDoc
@ -90,7 +90,7 @@ If you plan to submit patches, you should follow the following guidelines.
- the first line of the commit message should be a short; - the first line of the commit message should be a short;
description and should skip the full stop; description and should skip the full stop;
- if you want your work included, add a - if you want your work included, add a
`Signed-off-by: Your Name &lt;you@example.com>` line to the `Signed-off-by: Your Name <you@example.com>` line to the
commit message (or just use the option `-s` when committing); commit message (or just use the option `-s` when committing);
- make sure that you have tests for the bug you are fixing; - make sure that you have tests for the bug you are fixing;
- if possible, add a unit test to the test suite under spec/. - if possible, add a unit test to the test suite under spec/.