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

[Feature] Organise code with proper indentation and comments #101

Open
2 of 3 tasks
Xaid-vfx opened this issue Mar 22, 2023 · 11 comments
Open
2 of 3 tasks

[Feature] Organise code with proper indentation and comments #101

Xaid-vfx opened this issue Mar 22, 2023 · 11 comments
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work

Comments

@Xaid-vfx
Copy link
Contributor

Xaid-vfx commented Mar 22, 2023

Problem

The current code in the repository is not well defined, organized, or commented

Description

  • organize the code structure in accordance with standard rules and indentation
  • include comments to aid future contributors in understanding the function of each segment of code

For example:
This is the current code:
Screenshot 2023-03-22 at 4 26 14 PM
The above code looks messy.

The organized code:
Screenshot 2023-03-22 at 4 29 33 PM

Implementation

  • I would be interested in implementing this feature.
@Xaid-vfx Xaid-vfx added ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed labels Mar 22, 2023
@Xaid-vfx Xaid-vfx changed the title [Feature] <Organise code with proper indentation and comments> [Feature] Organise code with proper indentation and comments Mar 22, 2023
@Xaid-vfx

This comment was marked as outdated.

@possumbilities
Copy link
Contributor

@Xaid-vfx I think this helps in a lot of ways to make the code clearer. Nice idea! ❤️

@possumbilities possumbilities added 🏁 status: ready for work Ready for work and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Mar 22, 2023
@Xaid-vfx

This comment was marked as outdated.

@Xaid-vfx

This comment was marked as outdated.

@BalrajDhakad

This comment was marked as off-topic.

@BalrajDhakad

This comment was marked as off-topic.

@BalrajDhakad

This comment was marked as off-topic.

@Karan-Palan

This comment was marked as outdated.

@Peacesandy

This comment was marked as off-topic.

@TimidRobot
Copy link
Member

Please see Contribution Guidelines — Creative Commons Open Source for how we manage issues and PRs.

We generally don't assign issues prior to resolution. Instead of asking for issues to be assigned, do the work and submit a pull request (PR). Even if multiple people submit PRs for the same issue, multiple ideas and implementations strengthen the final product.

For work program applicants, each can all list their own PRs on their application. It is the quality of work that is important, not whether it is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work
Projects
Status: Backlog
7 participants
@TimidRobot @Xaid-vfx @Peacesandy @possumbilities @Karan-Palan @BalrajDhakad and others