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 in README #150

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

[Doc]: Adding a Project Structure Map in README #150

siri-chandana-macha opened this issue Nov 2, 2024 · 3 comments · Fixed by #157
Assignees
Labels
documentation Improvements or additions to documentation gssoc-ext GSSOC contribution hacktoberfest hacktoberfest contribution level2 GSSOC contribution level

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.
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

  • This helps new contributors quickly understand the project layout and find files easily.

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

Copy link

github-actions bot commented Nov 2, 2024

👋 Hey there, rockstar! Thanks for dropping an issue! The Quiz-Genius team is on it like pineapple on pizza (love it or hate it). Stick around, magic's about to happen!

@KirolosMFahem KirolosMFahem added documentation Improvements or additions to documentation gssoc-ext GSSOC contribution level2 GSSOC contribution level hacktoberfest hacktoberfest contribution labels Nov 2, 2024
@KirolosMFahem
Copy link
Collaborator

@siri-chandana-macha you're on it

Copy link

github-actions bot commented Nov 7, 2024

✅ This issue has been successfully closed. Thank you for your contribution and helping us improve the project! If you have any more ideas or run into other issues, feel free to open a new one. Happy coding! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation gssoc-ext GSSOC contribution hacktoberfest hacktoberfest contribution level2 GSSOC contribution level
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants