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

code quality improvements #37

Open
8 tasks
ryanamay opened this issue Aug 3, 2022 · 0 comments
Open
8 tasks

code quality improvements #37

ryanamay opened this issue Aug 3, 2022 · 0 comments
Labels
code quality Issues/PR's relating to code quality help wanted Extra attention is needed planned confirmed/planned additions

Comments

@ryanamay
Copy link
Owner

ryanamay commented Aug 3, 2022

The current code quality is garbage, with documentation only covering 8.4% of the entire codebase.
In addition to this, inconsistencies are seen everywhere.

Some notable ones are:

  • Tailwind CSS: Inconsistent padding, and it doesn't look clean.
  • Code Inconsistency: JS and TS are mixed up (well mostly on src/methods as public/ are excusable because of chrome extension limitations) (also because project is currently being ported to TS)
  • Code Inconsistency: Formatting
  • Code Inconsistency: Linting errors as provided by GitHub actions
  • Reusability: Some React Elements are Repetitive and can be turned into Reusable Components
  • Too Much Magic: Too much magic-oriented JavaScript code is present.
  • No Unit Tests: This project has no Tests.
  • Documentation: This project currently has a code coverage of 8.4%

Things can be improved here a lot and I know it myself. While I'm currently working on this, if you want to help with this, please make a pull request and mention this issue (do not link it) :)

@ryanamay ryanamay added code quality Issues/PR's relating to code quality help wanted Extra attention is needed planned confirmed/planned additions labels Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality Issues/PR's relating to code quality help wanted Extra attention is needed planned confirmed/planned additions
Projects
None yet
Development

No branches or pull requests

1 participant