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

Adding a Project Structure Map in the Documentation #707

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

Adding a Project Structure Map in the Documentation #707

siri-chandana-macha opened this issue Nov 2, 2024 · 4 comments · Fixed by #738

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

Thanks for creating the issue in ML-Nexus!🎉
Before you start working on your PR, please make sure to:

  • ⭐ Star the repository if you haven't already.
  • Pull the latest changes to avoid any merge conflicts.
  • Attach before & after screenshots in your PR for clarity.
  • Include the issue number in your PR description for better tracking.
    Don't forget to follow @UppuluriKalyani – Project Admin – for more updates!
    Tag @Neilblaze,@SaiNivedh26 for assigning the issue to you.
    Happy open-source contributing!☺️

Copy link

github-actions bot commented Nov 2, 2024

Hey @siri-chandana-macha, can you share the progress of this project?

@siri-chandana-macha
Copy link
Contributor Author

I will submit it by end of the day

Copy link

github-actions bot commented Nov 3, 2024

Hello @siri-chandana-macha! Your issue #707 has been closed. Thank you for your contribution!

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

Successfully merging a pull request may close this issue.

2 participants