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

[Other]: Adding a Project Structure Map in the Documentation #261

Open
3 of 4 tasks
siri-chandana-macha opened this issue Nov 2, 2024 · 1 comment
Open
3 of 4 tasks

Comments

@siri-chandana-macha
Copy link

What would you like to share?

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.

Additional information

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

Checklist

  • I have checked the existing issues.
  • I follow Contributing Guidelines of this project.
  • I am a IWOC'24 contributor.

Code of Conduct

Copy link

github-actions bot commented Nov 2, 2024

Hey, @siri-chandana-macha welcome to Top_Secrets repository.🎊 Thank you so much for taking the time to point this out.🙌

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

No branches or pull requests

1 participant