Skip to content

Metloom architecture - One class per file #116

Description

@jomey

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions