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 #342

Closed
siri-chandana-macha opened this issue Nov 2, 2024 · 3 comments · Fixed by #414
Closed

[Doc]: Adding a Project Structure Map #342

siri-chandana-macha opened this issue Nov 2, 2024 · 3 comments · Fixed by #414
Assignees
Labels
gssoc-ext Extended contribution for GSSoC hacktoberfest Open-source contribution during October for GSSoC hacktoberfest-accepted Eligible contribution for Hacktoberfest rewards level1 Beginner-level contribution or task

Comments

@siri-chandana-macha
Copy link
Contributor

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.

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

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

@Anuj3553 Anuj3553 added gssoc-ext Extended contribution for GSSoC hacktoberfest-accepted Eligible contribution for Hacktoberfest rewards level1 Beginner-level contribution or task hacktoberfest Open-source contribution during October for GSSoC labels Nov 2, 2024
@Anuj3553
Copy link
Collaborator

Anuj3553 commented Nov 2, 2024

Hyy @siri-chandana-macha, I'm assigning this issue to you.

@Anuj3553
Copy link
Collaborator

Anuj3553 commented Nov 4, 2024

Can you give star to this repo?

@siri-chandana-macha
Copy link
Contributor Author

siri-chandana-macha commented Nov 4, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc-ext Extended contribution for GSSoC hacktoberfest Open-source contribution during October for GSSoC hacktoberfest-accepted Eligible contribution for Hacktoberfest rewards level1 Beginner-level contribution or task
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants