rahulsainlll / git-trace

Git-Trace: Instantly search, view, and bookmark GitHub repositories and issues. Streamline your workflow and keep your favorite projects at your fingertips!
https://git-trace.vercel.app
MIT License
27 stars 52 forks source link

πŸ“ƒ Documentation Update: Adding a Project Structure Map #164

Open siri-chandana-macha opened 1 month ago

siri-chandana-macha commented 1 month ago

Describe the documentation update.

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

Why is this needed?

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

Additional context

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

github-actions[bot] commented 1 month ago

πŸ‘‹ Thanks for opening this issue! We appreciate your contribution. Please make sure you’ve provided all the necessary details and screenshots, and don't forget to follow our Guidelines and Code of Conduct. Happy coding! πŸš€