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

Reorg frontend file structure #180

Open
fzhao99 opened this issue Nov 27, 2024 — with Linear · 1 comment
Open

Reorg frontend file structure #180

fzhao99 opened this issue Nov 27, 2024 — with Linear · 1 comment

Comments

Copy link
Collaborator

fzhao99 commented Nov 27, 2024

Description:

Our frontend file structure might need some reorganization to reflect the application expanding. This is motivated by the components and designSystem modules living in the query subdirectory, implying these components don't apply to queryBuilding. This is wrong and should be fixed.

This may also be a good time to formalize how we create new directories in our frontend code / how we're applying our design system rules into our file structure

Acceptance Criteria:

  • Any norms that the team wants to bring up / agree upon are discussed. Non-exhaustive example questions:
    • How do we want to implement atomic design principles into application code?
    • When does a Figma design warrant a new component in designSystem rather than just a one-off implementation in components?
    • When do we make a new directory for a page vs just a tsx file?
  • An alternative folder structure is proposed to the team
    • Should probably start with components and designSystem in the query subdirectory, but can include more. Renames are also valid if needed
  • Any documentation from the above is created and signed off on.
  • Files are moved appropriately.
Copy link

linear bot commented Nov 27, 2024

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