]>
Commit | Line | Data |
---|---|---|
e323c15d UH |
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 | ||
5fea0267 UH |
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 | |
23 | hosting site. | |
24 | ||
25 | - Alternatively, patches can be sent to the development mailinglist at | |
e323c15d UH |
26 | sigrok-devel@lists.sourceforge.net (please subscribe to the list first). |
27 | ||
28 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
29 | ||
e323c15d UH |
30 | |
31 | Random notes | |
32 | ------------ | |
33 | ||
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 | |
38 | ||
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. | |
42 | ||
43 | ||
44 | Release engineering | |
45 | ------------------- | |
46 | ||
47 | See | |
48 | ||
49 | http://sigrok.org/wiki/Developers/Release_process | |
50 | ||
51 | for a list of items that need to be done when releasing a new tarball. | |
52 |