Wish to contribute to the development of this 3D Slicer module/extension? As a teamwork, this file mentions the code guidelines for this project. Please feel free to update this programming code of conduct if relevant. We appreciate your feedback.
-
This project uses the PEP8 convention for naming. Reminder:
- MyClass for naming a Class;
- MY_CONSTANT for naming a CONSTANT
- my_variable for naming a variable
- define_my_function() for naming a function (always start with an action verb)
- def my_function():
- """Add such a descriptive comment at the beginning of each function in order to explain clearly to the next user what does the function do. :) """
- TODO: for naming To Dos in the code
- One space line has been added between each function for clarity
- Useful comments are strongly encouraged.
- *Some of the code may not respects this convention, since previous related work did not seem to use any and some unmodified blocks has not been
- Want to report feature improvment/bug? Please open an issue if it has not already been done.
-
Useful links: