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

Metloom architecture - One class per file #116

Open
jomey opened this issue Aug 2, 2024 · 0 comments
Open

Metloom architecture - One class per file #116

jomey opened this issue Aug 2, 2024 · 0 comments

Comments

@jomey
Copy link

jomey commented Aug 2, 2024

As a newcomer to metloom, it is quite challenging to find specific classes or tests when trying to figure out execution logic. You can use your IDE (or preferred environment) to do a search and it sill leaves my head spinning when trying to navigate. Files also get quite long right now.

I am proposing three architectural changes/conventions:

  • File names to match their class
  • One class per file
  • Each class test file name corresponds with "test_my_awesome_class"

I have followed this pattern in the past and it makes code navigation quite simpler (especially for newcomers). It also makes testing each class simpler and organizes your test suite the same manner as your sources.

What do you guys think?

I am happy to prototype this in a PR

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

1 participant