You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
After looking at some aspects of the source code, I think we should starting thinking/considering about the below improvements in the source code in order to improve our further maintenance and development.
Refactor some of the common aspects of the code to a separate package in the same repo and reuse from them. Breaking it down improves the readability, understanding and maintenance of the code. Example instance of common code/logic across wrappers.
Update README.md with proper documentation on implementation and testing details (Atleast for the most commonly used usecases)
Use YAML configuration files to pass input params. As we have fairly large amount of arguments at this moment, I think we can use YAML configuration files and provide templates for them as it will help others as well to better adopt the usage.
Use **kwargs/dict to pass a large list of arguments across the methods. Example instance of huge argument list.
Add doc string to each function/method/class to improve readability as there seems to be lot many steps involved in the execution process.
I am open to other thoughts as well. Thank you
The text was updated successfully, but these errors were encountered:
This wrapper born for an specific task, create a number of HC, and delete them. Then it grew up parallel with hypershift and it was adapted to the requirements of the project, becoming on a big piece of unmaintainable code.
Im already working on a refactor, based on modules and classes, so we can reuse as much code as we can, but growing in the good way.
I really appreciate all your thoughts here, all of them will be considered in this new project, and I will share it when it will be ready as a MVP so we can all discuss about it
After looking at some aspects of the source code, I think we should starting thinking/considering about the below improvements in the source code in order to improve our further maintenance and development.
I am open to other thoughts as well. Thank you
The text was updated successfully, but these errors were encountered: