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.

Sign up for GitHub

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

Jump to bottom

Making Code and Comments consistent in codebase for Better Readability and Understanding #86

Closed
1 task done
IamMQaisar opened this issue Mar 16, 2024 · 0 comments · Fixed by #96
Closed
1 task done

Making Code and Comments consistent in codebase for Better Readability and Understanding #86

IamMQaisar opened this issue Mar 16, 2024 · 0 comments · Fixed by #96
Assignees
@IamMQaisar
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work

Comments

@IamMQaisar
Copy link
Contributor

IamMQaisar commented Mar 16, 2024 •
edited
Loading

Description

The code is not structured/organized well enough to be understood easily and Comments are not consistent in different files.

Expectation

The code Structure and Comments in all files should be similar to be understood easily.

Screenshots

In one example here, Comments are inconsistently mentioned and the code is unaligned/unorganized in different files.

Screenshot (277)

Additional context

Code is to be restructured/realigned and some additional alterations are required to make the codebase better.

Resolution

  • I would be interested in resolving this bug.
@IamMQaisar IamMQaisar added 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Mar 16, 2024
This was referenced Mar 16, 2024
Closed
Closed
@TimidRobot TimidRobot added help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work and removed 🟧 priority: high Stalls work on the project or its dependents 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Mar 16, 2024
This was referenced Mar 17, 2024
Closed
Merged
TimidRobot added a commit that referenced this issue Apr 2, 2024
@TimidRobot
Merge pull request #96 from IamMQaisar/shared_module
8412423 
Fixed: Refactor scripts #91, Adds logging #85 and Cleans code and comments #86 by Putting it in a Shared Library/Module
@IamMQaisar IamMQaisar mentioned this issue Apr 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@IamMQaisar IamMQaisar

Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work
Projects
None yet
Milestone
No milestone
2 participants
@TimidRobot @IamMQaisar