Skip to content

Refactor Code into a lib folder and form the basic layout and file structure of the library #3

@shaiknoorullah

Description

@shaiknoorullah

TODO

Since a basic implementation and PoC has been implemented, It's now time to refactor the code from one file to multiple files housing each function and class.

Things to consider while refactoring

  • Divide the code into three parts.

    1. The main library code which will be included in the package,
    2. The utility functions and code as helper functions but do not support the core implementation
    3. Code related to Observability, Testing and Logging.
  • Try to follow SOLID principles and best practices as much as possible

  • Document functions and classes in their own declaration / definition file

  • Separate folder for all the types and interfaces

  • Create a basic folder structure for the library not too specific

Metadata

Metadata

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions