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

Refactor: Restructure and Rename Directories and Components #31

Closed
7 tasks done
ash1eygrace opened this issue Mar 26, 2023 · 0 comments
Closed
7 tasks done

Refactor: Restructure and Rename Directories and Components #31

ash1eygrace opened this issue Mar 26, 2023 · 0 comments
Labels
High Pri Highest Priority refactor

Comments

@ash1eygrace
Copy link
Owner

ash1eygrace commented Mar 26, 2023

Overview

As the codebase has evolved over time, it has undergone several major overhauls and refactors. Due to these changes, the current structure and naming of directories and components no longer accurately reflect the functionality of the code. This issue aims to address the need for better organization and more intuitive naming conventions.

Goals

  • Restructure and reorganize the directory hierarchy to improve code maintainability and readability.
  • Rename components and directories to reflect their purpose and functionality better.
  • Update import paths and references to accommodate the new structure and naming conventions. (VSC will do this automatically and watch for the prompts)
  • Ensure that all tests continue to pass after the refactoring process.

Proposed Changes

  • Group related components and functionalities into cohesive modules, keeping new features in mind.
  • Use clear, descriptive, and consistent naming conventions for directories and components.
  • Separate components into folders based on their type (e.g., containers, presentational components, utility functions, etc.).
  • Update any relevant documentation to reflect the new organization and naming.

Task Breakdown

  • Research established conventions and best practices in similar projects or industry standards and learn from their organization and naming methodologies.
  • Review the current codebase and identify components and directories that need to be restructured or renamed.
  • Plan and design a new directory hierarchy that is more logical, maintainable, and in line with researched conventions.
  • Rename and reorganize components and directories according to the new design.
  • Update import paths and references throughout the codebase.
  • Test and ensure that the application still works as expected.
  • Review and update any affected documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
High Pri Highest Priority refactor
Projects
None yet
Development

No branches or pull requests

1 participant