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

Open
siri-chandana-macha opened this issue Nov 3, 2024 · 0 comments
Open
Labels
enhancement πŸ§‘β€πŸ’» New feature or request Up-for-Grabs βœ‹ Issues are open to the contributors to be assigned

Comments

@siri-chandana-macha
Copy link

πŸ”΄ Title : Project Structure
πŸ”΄ Changes : 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.

Screenshots πŸ“·

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


βœ… To be Mentioned while taking the issue :

  • Full name : Siri Chandana Macha
  • What is your participant role? GSSOC , Hacktoberfest

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

@siri-chandana-macha siri-chandana-macha added enhancement πŸ§‘β€πŸ’» New feature or request Up-for-Grabs βœ‹ Issues are open to the contributors to be assigned labels Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement πŸ§‘β€πŸ’» New feature or request Up-for-Grabs βœ‹ Issues are open to the contributors to be assigned
Projects
None yet
Development

No branches or pull requests

1 participant