Refactor and avoid parallel development

maxradx commented 2 weeks ago

This issue is about adopting a convention with consensus in order to avoid parallel development in the programming code, and ensure compatibility between developements.

Here are the links for a convention that could be adapted (PEP8)

In brief:

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)
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 refractored in that context

Action tasks:

[ ] Discuss with Dr. Letourneau-Guillon and team about conventino that they used @llaurentletg
[ ] Refractor the remaining parts of the code (from both team) to unify it

jcohenadad commented 2 weeks ago

Having a CONTRIBUTING.md file would be a good starting point.

maxradx commented 2 weeks ago

Having a CONTRIBUTING.md file would be a good starting point.

Done! (but link for new issues still to be added) Keeping issue opened since this is will evolve according to future discussions with Dr. Letourneau-Guillon's team.

maxradx commented 5 days ago

*Officially added CONTRIBUTING.md and there is now a template proposed for code contribution when opening an issue. Please feel free to modify/give feedback to optimize its adoption. CONTRIBUTING.md

neuropoly / slicer-manual-annotation

Refactor and avoid parallel development #4