cloud-bulldozer / cloud-bulldozer/perfscale-managed-services

Improvement suggestions in the source code

Open
#161 1 comment 0 reactions 5 assignees Claimed by @dry923 View on GitHub
Dominant language
Python
Stars
2
Forks
11
PR merge metrics
No merged PRs in 30d

Description

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](https://drive.google.com/file/d/1MSKJFdriPnZGsDe8082WSZwFayOHkQ5a/view?usp=sharing) 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](https://github.com/cloud-bulldozer/kube-burner/tree/master/examples/workloads) for them as it will help others as well to better adopt the usage.
* Use [**kwargs/dict](https://www.geeksforgeeks.org/args-kwargs-python/) to pass a large list of arguments across the methods. Example [instance](https://github.com/cloud-bulldozer/perfscale-managed-services/blob/8566fea6dcc7f41067270ce0672981cadc204e57/rosa-hypershift/rosa-hosted-wrapper.py#L526) of huge argument list.
* Add [doc string](https://peps.python.org/pep-0257/) 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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.