Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
doc:contribute:start [2019/02/22 11:04]
127.0.0.1 external edit
— (current)
Line 1: Line 1:
- 
-====== Contributing to Smil ====== 
- 
-This section contains guidelines on how to contribute to SMIL. 
- 
-Please note that in order to some code be integrated to SMIL distribution it must : 
- 
-  * be human readable : other than computer readable. Verify that your code is formatted with SMIL style. Just run : ''​clang-format -i -style=file filename''​ on each of your contributed files; 
- 
-  * compiles with NO WARNINGS and NO ERRORS. Warnings at compile time means a potential problem; 
- 
-  * all functions works with all defined Image types : UINT8, UINT16, UINT32. If this isn't the case, there shall be a mention clear stating it (eventually with the reason); 
- 
-  * be aware that code will be checked against bad programming practices and, eventually, corrected or rejected. 
-  
-  * algorithms shall be documented in the source code with references when needed; 
- 
-  * all visible objects shall have their prototypes documented with Doxygen in order to be automatically integrated into the documentation. ​ 
  
doc/contribute/start.1550829850.txt.gz ยท Last modified: 2019/02/22 11:04 by 127.0.0.1
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0