1 -------------------------------------------------------------------------------
3 -------------------------------------------------------------------------------
8 This project is programmed using the Linux kernel coding style, see
9 http://lxr.linux.no/linux/Documentation/CodingStyle for details.
11 Please use the same style for any code contributions, thanks!
13 In some exceptional cases deviations from the above coding guidelines are
14 OK (in order to meet fx2lib related guidelines, for example).
20 - In order to contribute you should ideally clone the git repository and
21 let us know (preferably via IRC, or via the mailing list) from where to
22 pull/review your changes. You can use github.com, or any other public git
25 - Alternatively, patches can be sent to the development mailinglist at
26 sigrok-devel@lists.sourceforge.net (please subscribe to the list first).
28 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
34 - Consistently use the same naming convention for #include guards in headers:
35 <PROJECTNAME>_<PATH_TO_FILE>_<FILE>
36 This ensures that all #include guards are always unique and consistent.
37 Example: FX2LAFW_INCLUDE_COMMAND_H
39 - In Doxygen comments, put an empty line between the block of @param lines
40 and the final @return line. The @param lines themselves (if there is more
41 than one) are not separated by empty lines.
49 http://sigrok.org/wiki/Developers/Release_process
51 for a list of items that need to be done when releasing a new tarball.