HACKING

   1 -------------------------------------------------------------------------------
   2 HACKING
   3 -------------------------------------------------------------------------------
   4
   5 Coding style
   6 ------------
   7
   8 This project is programmed using the Linux kernel coding style, see
   9 http://lxr.linux.no/linux/Documentation/CodingStyle for details.
  10
  11 Please use the same style for any code contributions, thanks!
  12
  13 In some exceptional cases deviations from the above coding guidelines are
  14 OK (in order to meet fx2lib related guidelines, for example).
  15
  16
  17 Contributions
  18 -------------
  19
  20  - Patches should be sent to the development mailinglist at
  21    sigrok-devel@lists.sourceforge.net (please subscribe to the list first).
  22
  23    https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  24
  25  - Alternatively, you can also clone the git repository and let us know
  26    from where to pull/review your changes. You can use gitorious.org,
  27    github.com, or any other public git hosting site.
  28
  29
  30 Random notes
  31 ------------
  32
  33  - Consistently use the same naming convention for #include guards in headers:
  34    <PROJECTNAME>_<PATH_TO_FILE>_<FILE>
  35    This ensures that all #include guards are always unique and consistent.
  36    Example: FX2LAFW_INCLUDE_COMMAND_H
  37
  38  - In Doxygen comments, put an empty line between the block of @param lines
  39    and the final @return line. The @param lines themselves (if there is more
  40    than one) are not separated by empty lines.
  41
  42
  43 Release engineering
  44 -------------------
  45
  46 See
  47
  48  http://sigrok.org/wiki/Developers/Release_process
  49
  50 for a list of items that need to be done when releasing a new tarball.
  51