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

File Organization Improvements & Code Structure #125

Closed
Manason opened this issue Sep 23, 2024 · 0 comments
Closed

File Organization Improvements & Code Structure #125

Manason opened this issue Sep 23, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Manason
Copy link
Member

Manason commented Sep 23, 2024

The problem

Files have large scope and broad categories, making it difficult to navigate, find, and read code

Ideal solution

  • Break the files up by feature most likely, so related code can go together and files can be more focused on something specific
  • Look for opportunities to rename things to be less confusing. Right now there are multiple paths to the same outcome, but we should funnel code paths through the same functions for consistency with checks and to simplify the code.
  • API should be clear (public net events, exports), which smaller file sizes contribute to. Backwards compatible API endpoints should be commented as such and marked deprecated.
  • It seems like there are abstractions that may make the code harder to navigate without adding value. Right now we have files that are collection of functions, which isn't specific enough to be useful.

Alternative solutions

No response

Additional context

No response

@Manason Manason added the enhancement New feature or request label Sep 23, 2024
@qbox-duck qbox-duck bot added this to Issues Sep 23, 2024
@github-project-automation github-project-automation bot moved this to Todo in Issues Sep 23, 2024
@Manason Manason closed this as completed Oct 26, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Issues Oct 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

1 participant