Slicer3:Style - Revision history

Pieper: /* General Considerations */

2010-04-15T13:14:51Z

General Considerations

Pieper: /* Contributions */

2010-02-09T13:26:59Z

Contributions

Pieper: /* Contributions */

2010-02-01T13:59:26Z

Contributions

Pieper: /* Contributions */

2010-01-20T14:58:16Z

Contributions

Pieper: /* Licensing */

2010-01-20T14:57:10Z

Licensing

Sylvainjaume: /* General Considerations */

2009-06-07T17:30:28Z

General Considerations

Marianna: /* Licensing */

2008-05-20T17:42:33Z

Licensing

Marianna: 1 revision

2008-05-15T17:55:50Z

1 revision

Pieper: /* General Considerations */

2007-07-23T12:27:19Z

General Considerations

New page

== General Considerations ==

A few things to keep in mind:

* All C++ classes must conform to the ''style conventions of their parent classes''.
** In most cases for Slicer Base, this means following VTK coding conventions including naming, indentation, and other issues discussed at the [http://www.vtk.org/Wiki/VTK_Coding_Standards VTK Coding Standards] page. This means using the VTK two-space indent style (even if you don't like it!).
** For command line modules implemented in ITK, follow the conventions defined in [[media:Style.pdf | Insight/Documentation/Style.pdf]] from the ITK distribution.
** Libraries (such as Teem, zlib, etc) may follow their own coding styles, and be wrapped with in classes with the appropriate styles.

Highlights of the policies:
* ''avoid acronyms in class'' and method names
** some standard acronyms can be use (IJK, RAS, MRML, etc)
** ''acronyms should be capitalized as a whole'', not by first letter (e.g. RASToIJK is correct -- RasToIjk ''is not correct'' )
* use ''2 spaces for indentation'', not tabs
* think carefully about the reusability of your class hierarchies
* comment your code extensively
* ''do not leave dead code'' in the source files. Large blocks of commented out code makes the source file hard to read. Instead, include a comment that points to a previous revision number in svn that has the previous revision you are removing.

Code that will be included in slicer must use CMake for cross platform building.

== Licensing ==

Code is released under the [http://slicer.org/copyright/copyright.txt slicer license].

All NA-MIC funded software, data, documentation, and other materials should include [[Publications:NIH_Roadmap_acknowledgement | the NIH Roadmap acknowledgement]].

Please add acknowledgements for any and all grants that helped fund your development work. See [[Slicer3:Acknowledgements]] for lists of grants and grant numbers.

← Older revision		Revision as of 13:26, 9 February 2010
Line 39:		Line 39:
	** [[Slicer3.4:Training\|Tutorials]]		** [[Slicer3.4:Training\|Tutorials]]
	* Also, please have a support plan for the future. If you will not be willing to respond to future questions about the code, then find someone who is willing or don't submit the code.		* Also, please have a support plan for the future. If you will not be willing to respond to future questions about the code, then find someone who is willing or don't submit the code.
		+
		+	Review [[Documentation-3.5-Rons-Rules\|Ron's requirements for a good module]].

@@ Line 36: / Line 36: @@
 * Code is not considered complete without the following:
 ** [[Slicer3:Testing|Tests]]
 ** [[Slicer3.4:Training|Tutorials]]
 * Also, please have a support plan for the future.  If you will not be willing to respond to future questions about the code, then find someone who is willing or don't submit the code.

@@ Line 36: / Line 36: @@
 * Code is not considered complete without the following:
 ** [[Slicer3:Testing|Tests]]
-** [[Slicer3:Tutorials|Tutorials]]
+** [[Slicer3.4:Training|Tutorials]]
 * Also, please have a support plan for the future.  If you will not be willing to respond to future questions about the code, then find someone who is willing or don't submit the code.

← Older revision		Revision as of 14:57, 20 January 2010
Line 26:		Line 26:

	Please add acknowledgments for any and all grants that helped fund your development work. See [[Slicer3:Acknowledgements]] for lists of grants and grant numbers.		Please add acknowledgments for any and all grants that helped fund your development work. See [[Slicer3:Acknowledgements]] for lists of grants and grant numbers.
		+
		+	== Contributions ==
		+
		+	Bug fixes and ports to new platforms are always welcome from anyone in the slicer community.
		+
		+	People interested in contributing new functionality should consider the following:
		+
		+	* The [[Slicer3:Extensions\|Slicer3 Extension Modules]] are the recommended way to get new application functionality into slicer.
		+	* Code is not considered complete without the following:
		+	** [[Slicer3:Testing\|Tests]]
		+	** [[Slicer3:Tutorials\|Tutorials]]
		+	* Also, please have a support plan for the future. If you will not be willing to respond to future questions about the code, then find someone who is willing or don't submit the code.

@@ Line 8: / Line 8: @@
 ** Libraries (such as Teem, zlib, etc) may follow their own coding styles, and be wrapped within classes with the appropriate styles.
-Highlights of the policies:
+Highlights of the [[Slicer3:Style_and_Conventions|policies and conventions]]:
 * ''avoid acronyms in class'' and method names
 ** some standard acronyms can be use (IJK, RAS, MRML, etc)

@@ Line 6: / Line 6: @@
 ** In most cases for Slicer Base, this means following VTK coding conventions including naming, indentation, and other issues discussed at the [http://www.vtk.org/Wiki/VTK_Coding_Standards VTK Coding Standards] page.  This means using the VTK two-space indent style (even if you don't like it!).
 ** For command line modules implemented in ITK, follow the conventions defined in [[media:Style.pdf | Insight/Documentation/Style.pdf]] from the ITK distribution.
-** Libraries (such as Teem, zlib, etc) may follow their own coding styles, and be wrapped with in classes with the appropriate styles.
+** Libraries (such as Teem, zlib, etc) may follow their own coding styles, and be wrapped within classes with the appropriate styles.
 Highlights of the policies:

@@ Line 23: / Line 23: @@
 Code is released under the [http://slicer.org/copyright/copyright.txt slicer license].
-All NA-MIC funded software, data, documentation, and other materials should include [[Publications:NIH_Roadmap_acknowledgement | the NIH Roadmap acknowledgement]].
+All NA-MIC funded software, data, documentation, and other materials should include [[Publications:NIH_Roadmap_acknowledgement | the NIH Roadmap acknowledgment]].
-Please add acknowledgements for any and all grants that helped fund your development work.  See [[Slicer3:Acknowledgements]] for lists of grants and grant numbers.
+Please add acknowledgments for any and all grants that helped fund your development work.  See [[Slicer3:Acknowledgements]] for lists of grants and grant numbers.

← Older revision	Revision as of 17:55, 15 May 2008
(No difference)