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

[Documentation Update]: Adding a Project Structure Map in README #668

Open
4 tasks done
siri-chandana-macha opened this issue Nov 2, 2024 · 1 comment
Open
4 tasks done
Labels
gssoc-ext hacktoberfest-accepted For valid PRs during hacktoberfest event

Comments

@siri-chandana-macha
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Issue Description

Adding a clear structure map in the documentation to guide contributors on where specific files and folders are located and what they contain.

Suggested Change

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

Rationale

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

Urgency

High

Record

  • I have read the Contributing Guidelines
  • I'm a GSSOC'24 contributor
  • I have starred the repository
@github-actions github-actions bot added gssoc-ext hacktoberfest-accepted For valid PRs during hacktoberfest event labels Nov 2, 2024
Copy link

github-actions bot commented Nov 2, 2024

Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc-ext hacktoberfest-accepted For valid PRs during hacktoberfest event
Projects
None yet
Development

No branches or pull requests

1 participant