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

[Doc]: Adding a Project Structure Map #208

Open
siri-chandana-macha opened this issue Nov 2, 2024 · 1 comment
Open

[Doc]: Adding a Project Structure Map #208

siri-chandana-macha opened this issue Nov 2, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@siri-chandana-macha
Copy link

siri-chandana-macha commented Nov 2, 2024

Feature Title

Project Structure Map

Problem Statement

Adding a clear structure map in the documentation to guide contributors on where specific files and folders are located and what they contain.
This helps new contributors quickly understand the project layout and find files easily.

Proposed Solution

For example:

Project Root
├── src/      # Core application files
│ ├── components/      # Reusable UI components
│ ├── services/      # API calls and business logic
│ ├── utils/      # Utility functions
│ └── index.js      # Main entry file
├── assets/      # Images, icons, and other static assets
├── config/      # Configuration files (e.g., env variables)
└── README.md      # Project overview and instructions

Alternatives Considered

No response

Additional Context

please kindly assign this issue under gssoc-extd and hacktoberfest-accepted and level

@siri-chandana-macha siri-chandana-macha added the enhancement New feature or request label Nov 2, 2024
Copy link

github-actions bot commented Nov 2, 2024

👋 Thank you! Welcome to the project! Please follow these guidelines for smooth collaboration:

  1. After completing a task, add your name and details to the Contributors Table/List.
  2. Attach relevant screenshots or videos of your contribution for transparency.
  3. Tasks are assigned on a first-come, first-served basis.
    • Avoid spamming requests for already-assigned tasks.
    • Respect the queue and wait for new tasks.
  4. Propose New Ideas: Discuss new features or suggestions in the "Ideas" channel before starting work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant