mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 04:57:30 +03:00
contributions.md: add rules for documentation
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
parent
d0e83d7076
commit
586acf7502
@ -2,10 +2,10 @@ Contributing a module {#contributions}
|
|||||||
=====================
|
=====================
|
||||||
|
|
||||||
Here are the rules of contribution:
|
Here are the rules of contribution:
|
||||||
- Try not to break master. In any commit.
|
- Your module must have an example that builds against your UPM library
|
||||||
- Commits must have a sign-off line by everyone who reviewed them
|
- Commits must have a sign-off line by everyone who reviewed them
|
||||||
- Commits must be named <file/module>: Some decent description
|
- Commits must be named <file/module>: Some decent description
|
||||||
- You must license your module under an FOSS license. The recommended license
|
- You must license your module under a FOSS license. The recommended license
|
||||||
is MIT but any permissive license is fine. Please consider that people using
|
is MIT but any permissive license is fine. Please consider that people using
|
||||||
UPM may want to write proprietary programs with your sensors so we like to
|
UPM may want to write proprietary programs with your sensors so we like to
|
||||||
avoid GPL. (LGPL is fine). If your license is not MIT please include a
|
avoid GPL. (LGPL is fine). If your license is not MIT please include a
|
||||||
@ -13,4 +13,22 @@ Here are the rules of contribution:
|
|||||||
- Please test your module builds before contributing and make sure it works on
|
- Please test your module builds before contributing and make sure it works on
|
||||||
the latest version of mraa. If you tested on a specific board/platform please
|
the latest version of mraa. If you tested on a specific board/platform please
|
||||||
tell us what this was in your PR.
|
tell us what this was in your PR.
|
||||||
|
- Try not to break master. In any commit.
|
||||||
|
- Attempt to have some decent API documentation below are the explicit rules on documentation:
|
||||||
|
|
||||||
|
Documentation
|
||||||
|
=============
|
||||||
|
|
||||||
|
- Try to have no warnings in doxygen, this is generally fairly easy
|
||||||
|
- Have the specific sensor manufacturer/model & version that you used, if you
|
||||||
|
support multiple versions please list
|
||||||
|
- Comments do not need full stops
|
||||||
|
- Stick to <80 chars per line even in comments
|
||||||
|
- No text is allowed on the same line as the start or end of a comment /** */
|
||||||
|
- All classes should have a "@brief" and a "@snippet"
|
||||||
|
|
||||||
|
The example should have an 'Interesting' section which will be highlighted as a
|
||||||
|
code sample in doxygen. Everything in between such tags will show up in the
|
||||||
|
class documentation when the following is put at the end of a class docstring
|
||||||
|
as show above.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user