[sigrok-firmware-fx2lafw.git] / HACKING

-------------------------------------------------------------------------------
HACKING
-------------------------------------------------------------------------------

Coding style
------------

This project is programmed using the Linux kernel coding style:

  https://www.kernel.org/doc/html/latest/process/coding-style.html

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
-------------

 - In order to contribute you should ideally clone the git repository and
   let us know (preferably via IRC, or via the mailing list) from where to
   pull/review your changes. You can use github.com, or any other public git
   hosting site.

 - Alternatively, patches can 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


Random notes
------------

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