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

[FEATURE] Add File Storage Documentation to README #211

Open
1 task done
banasmita24 opened this issue Oct 26, 2024 · 2 comments
Open
1 task done

[FEATURE] Add File Storage Documentation to README #211

banasmita24 opened this issue Oct 26, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request gssoc GirlScript Summer Of Code gssoc-ext GirlScript Summer Of Code hacktoberfest hacktoberfest hacktoberfest-accepted hacktoberfest level1 GirlScript Summer Of Code - 15 points status: ready for dev You can asked for this issue to be assigned (if not already assigned)

Comments

@banasmita24
Copy link

Is this feature already requested?

  • I have checked "open" and "closed" issues, and this is not a duplicate.

Problem or Missing Functionality

New contributors often struggle to understand the project’s structure and may find it challenging to locate specific files, which can lead to confusion and impact the efficiency of their contributions.

Feature Description

I suggest adding a "File Structure" section in the README that outlines key folders and files along with brief descriptions. This addition would help new contributors and maintainers quickly understand the organization of the project and locate relevant files.
Including this documentation directly in the README makes it immediately visible, similar to how other open-source projects outline file structures, which helps improve onboarding and clarity for all users.

Screenshots

No response

Would you like to work on this feature?

Yes

Implementation Plan

I plan to start by reviewing the current file structure and drafting concise descriptions for each key folder and file. I will then update the README to include these descriptions, using Markdown formatting for clarity. This will ensure the feature is organized and easy to navigate.

Thank you:)

@banasmita24 banasmita24 added the status: awaiting triage Waiting for maintainers to verify (please do not start work on this yet) label Oct 26, 2024
Copy link

👋 Thank you @banasmita24 for raising an issue! We appreciate your effort in helping us improve. Our team will review it shortly. Stay tuned!

@ajaynegi45
Copy link
Owner

Is this feature already requested?

  • I have checked "open" and "closed" issues, and this is not a duplicate.

Problem or Missing Functionality

New contributors often struggle to understand the project’s structure and may find it challenging to locate specific files, which can lead to confusion and impact the efficiency of their contributions.

Feature Description

I suggest adding a "File Structure" section in the README that outlines key folders and files along with brief descriptions. This addition would help new contributors and maintainers quickly understand the organization of the project and locate relevant files. Including this documentation directly in the README makes it immediately visible, similar to how other open-source projects outline file structures, which helps improve onboarding and clarity for all users.

Screenshots

No response

Would you like to work on this feature?

Yes

Implementation Plan

I plan to start by reviewing the current file structure and drafting concise descriptions for each key folder and file. I will then update the README to include these descriptions, using Markdown formatting for clarity. This will ensure the feature is organized and easy to navigate.

Thank you:)

Hi @banasmita24,

Thank you for expressing your interest in working on this issue. I'm delighted to inform you that I have assigned this issue to you. Your willingness to contribute to our project is much appreciated.

Write File Structure in File_Structure.md file. Explain detailed File Structure

Before making any contributions, please read the Readme.md file carefully to better understand the project's goals and purpose. This will give you clarity on our mission. Also, make sure to review the Contributing.md file, which contains important guidelines to make the contribution process smoother, especially for newcomers.

Feel free to start working, and if you have any questions or need assistance during the process, please don't hesitate to reach out.

@ajaynegi45 ajaynegi45 added enhancement New feature or request status: ready for dev You can asked for this issue to be assigned (if not already assigned) hacktoberfest hacktoberfest gssoc GirlScript Summer Of Code hacktoberfest-accepted hacktoberfest level1 GirlScript Summer Of Code - 15 points gssoc-ext GirlScript Summer Of Code labels Oct 27, 2024
@ajaynegi45 ajaynegi45 removed the status: awaiting triage Waiting for maintainers to verify (please do not start work on this yet) label Oct 27, 2024
This was referenced Oct 28, 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 gssoc GirlScript Summer Of Code gssoc-ext GirlScript Summer Of Code hacktoberfest hacktoberfest hacktoberfest-accepted hacktoberfest level1 GirlScript Summer Of Code - 15 points status: ready for dev You can asked for this issue to be assigned (if not already assigned)
Projects
None yet
Development

No branches or pull requests

2 participants