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

Some much needed refactoring #59

Merged
merged 9 commits into from
May 21, 2021
Merged

Some much needed refactoring #59

merged 9 commits into from
May 21, 2021

Conversation

thecodrr
Copy link
Owner

@thecodrr thecodrr commented Apr 19, 2021

Why:

The current codebase is all over the place. It lacks consistency, is hard to navigate and the amount of things being passed around in function calls is absurd. As such, contributing is a nightmare.

After this much needed refactoring, hopefully, it will be more readable and maintainable.

Goals:

  • No breaking changes
  • Consistent function, variable & parameter naming
  • Good internal function commenting
  • Write ARCHITECTURE.md
  • Write CONTRIBUTING.md
  • Simplify function signatures as much as possible
  • No performance regressions
  • (Optional) Reduce as many closures as possible

@thecodrr thecodrr merged commit 3419f61 into master May 21, 2021
@thecodrr thecodrr deleted the refactor branch May 21, 2021 12:52
@papb
Copy link
Contributor

papb commented May 23, 2021

Nice work!!

@thecodrr
Copy link
Owner Author

Thanks! @papb

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

Successfully merging this pull request may close these issues.

2 participants