Fixes Making Code and Comments consistent in codebase for Better Readability and Understanding

IamMQaisar commented 3 months ago

Fixes

Fixes #86 cc: @TimidRobot

Description

Modifications were made to the files related to comments, realigned the code for better understanding, removed repeatedly used files, and used only once from the root.

Technical details

legal-tool-paths.txt is moved from directories to the root directory so that it can be used for all related scripts from a single place. Also, the root_path instance is made to be used for both .env and legal-tool-paths.txt.

Checklist

[x] My pull request has a descriptive title (not a vague title like Update index.md).
[x] My pull request targets the default branch of the repository (main or master).
[x] My commit messages follow best practices.
[x] My code follows the established code style of the repository.
[ ] I added or updated tests for the changes I made (if applicable).
[ ] I added or updated documentation (if applicable).
[x] I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin

``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```

IamMQaisar commented 3 months ago

This Pull needs to be reviewed first, then logging #90 and so in the end Shared Scripts #95 Pull Request. As it will break down the process, because concurrent changes in logging files, and then sharing scripts are introduced.

IamMQaisar commented 3 months ago

Closing this Pull and doing all issues #86 #85 and #91 solutions in a single pull #95. This will show you only the latest changes, with organized code, added logger, and shared module, to help you not get cluttered in the codebase with multiple changes. @TimidRobot

creativecommons / quantifying