Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvement suggestions in the source code #161

Open
vishnuchalla opened this issue Jun 15, 2023 · 1 comment
Open

Improvement suggestions in the source code #161

vishnuchalla opened this issue Jun 15, 2023 · 1 comment
Assignees

Comments

@vishnuchalla
Copy link

vishnuchalla commented Jun 15, 2023

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

@morenod
Copy link
Collaborator

morenod commented Jun 16, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants