Interest in InVesalius project - Adding type information to functions, methods, and classes

[sudarsan2k5]

Hi,

I am Sudarsan Mansingh and I am writing to express my interest in the InVesalius project, specifically the project idea of "Adding type information to functions, methods, and classes".

I have conducted some initial research on this topic and I am excited about the potential impact it could have on the InVesalius codebase. By adding type information, we can improve the code's readability, maintainability, and reduce the likelihood of errors. Additionally, the Github-CI action for catching type errors using tools like Mypy would make it easier to catch issues early on, before they become more difficult to debug.

To begin, I plan to first familiarize myself with the InVesalius codebase and the Python typing module. Next, I will create a list of functions, methods, and classes that require type annotations and add appropriate annotations to their parameters and return types.

Once the type information is added, I will create a Github-CI action to run Mypy on the codebase and catch any type errors. I will also ensure that the codebase adheres to best practices for typing, such as using Union types where appropriate and avoiding the use of "Any" types.

Throughout the project, I plan to communicate regularly with the InVesalius community, seek feedback, and collaborate on any challenges or issues that arise.

I believe that this project would be a valuable contribution to InVesalius and I am eager to work on it during GSOC 2023. Please let me know if you have any feedback or suggestions on my proposed approach. Specifically, I would like to know if there are any specific resources, tools or libraries that I should focus on to help me get started.

Thank you so much for your time and I am looking forward to hearing back from you soon.

[paulojamorim]

Hi @sudarsan2k5 ,

Thanks for your interest! We will put the guidelines here (github) soon.

[tfmoraes]

Hi @sudarsan2k5 the guideline are here https://github.com/invesalius/gsoc/blob/main/gsoc_application.md