From: Uwe Hermann Date: Tue, 16 Oct 2012 13:24:29 +0000 (+0200) Subject: Add a HACKING file. X-Git-Tag: sigrok-firmware-fx2lafw-0.1.1~19 X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=e323c15dc4d27d452602e147102e6cdfd4c7d0c3;p=sigrok-firmware-fx2lafw.git Add a HACKING file. --- diff --git a/HACKING b/HACKING new file mode 100644 index 00000000..77fea0e5 --- /dev/null +++ b/HACKING @@ -0,0 +1,51 @@ +------------------------------------------------------------------------------- +HACKING +------------------------------------------------------------------------------- + +Coding style +------------ + +This project is programmed using the Linux kernel coding style, see +http://lxr.linux.no/linux/Documentation/CodingStyle for details. + +Please use the same style for any code contributions, thanks! + +In some exceptional cases deviations from the above coding guidelines are +OK (in order to meet fx2lib related guidelines, for example). + + +Contributions +------------- + + - Patches should be sent to the development mailinglist at + sigrok-devel@lists.sourceforge.net (please subscribe to the list first). + + https://lists.sourceforge.net/lists/listinfo/sigrok-devel + + - Alternatively, you can also clone the git repository and let us know + from where to pull/review your changes. You can use gitorious.org, + github.com, or any other public git hosting site. + + +Random notes +------------ + + - Consistently use the same naming convention for #include guards in headers: + __ + This ensures that all #include guards are always unique and consistent. + Example: FX2LAFW_INCLUDE_COMMAND_H + + - In Doxygen comments, put an empty line between the block of @param lines + and the final @return line. The @param lines themselves (if there is more + than one) are not separated by empty lines. + + +Release engineering +------------------- + +See + + http://sigrok.org/wiki/Developers/Release_process + +for a list of items that need to be done when releasing a new tarball. +