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

Refactoring is Needed! #171

Open
4 tasks
ABGEO opened this issue Aug 9, 2024 · 1 comment
Open
4 tasks

Refactoring is Needed! #171

ABGEO opened this issue Aug 9, 2024 · 1 comment

Comments

@ABGEO
Copy link

ABGEO commented Aug 9, 2024

Great project, but the code could use some improvement!

First off, I want to commend the work that has been done here. However, I've noticed that the code could benefit from some significant refactoring to improve readability and maintainability. While I don't have much time to contribute a PR myself, I believe these changes would greatly benefit the project's long-term development.

To start, here are a few key areas we could focus on:

  • Decouple and organize the code into smaller, more manageable components. This will make the codebase easier to navigate and maintain.
  • Refactor the main component. At a minimum, separate the header and source files to promote modularity.
  • Simplify and streamline the main.c file. Keep it as concise as possible, with all business logic extracted into other headers/components.
  • Integrate linting tools. ESP-IDF uses tools like pre-commit and astyle. Leveraging these here would help ensure code quality.

If anyone has the time to tackle these items, it would be a great step forward for the project!

@meatpiHQ
Copy link
Owner

@ABGEO Thanks for the suggestions. I wish I could afford to put time into refactoring :)

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

2 participants