Skip to content

Add Project Folder Structure to README for Better Contributor Clarity #114

Description

@SanikaDahiwal0015

Description:

The current README does not clearly explain the project folder structure. Because of this, new contributors sometimes add unnecessary or misplaced files, making the repository harder to navigate and maintain.

To improve clarity and consistency, we should add a dedicated Project Structure section in the README that explains the directory layout and purpose of each major folder.

Proposed Change:

Add a section in README.md like:

Clearly list main folders (app/, prisma/, public/, scripts/, etc.)
Briefly describe what each folder is used for
Include important files and their purpose (e.g., vite.config.ts, .env.example)
Add simple rules for contributors on where to place new code

Expected Outcome:
New contributors understand project structure immediately
Reduces creation of unnecessary or random files
Improves consistency in codebase organization
Makes onboarding faster and smoother

Additional Suggestion (Optional):

We can also add a small “Contributor Rules” note under this section to guide where code, components, and utilities should be placed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions