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

Enhance Readme & Add Learn.md file #46

Open
aasthakourav20 opened this issue May 16, 2024 · 4 comments · May be fixed by #106
Open

Enhance Readme & Add Learn.md file #46

aasthakourav20 opened this issue May 16, 2024 · 4 comments · May be fixed by #106
Assignees

Comments

@aasthakourav20
Copy link

What's missing in this repository !!

A README file is essential in any given repository because it serves as the primary source of information about the project. It provides an overview of the project's purpose, how to install and use it, and any necessary prerequisites. Additionally, the README often includes guidelines for contributing, links to documentation, and contact information for the maintainers. This file ensures that both new and returning users can easily understand the project's scope, setup, and usage, thereby enhancing the project's accessibility and fostering collaboration

Learn repos should have a LEARN.md file to teach student how to build your project step by step. You can explain how to build your project with text, code snippets, images, or even short (5 minute) long video lessons. As the maintainer of a Learn repo, the LEARN.md file requires you to think critically about how to explain the building of your project and how to also make it engaging. We don't expect you to be an expert teacher, but we would like you to reflect on how difficult it was to get to your level of knowledge, and then provide friendly guidance to help other students to learn.

Reference: https://github.com/Recode-Hive/Stackoverflow-Analysis/blob/main/Learn.md

Kindly assign this issue to me under GSSoC'24

@Harshil-Jani
Copy link
Member

Hey @aasthakourav20 I believe we have some other improvement on README but it would really be a great idea to write LEARN.md as you have mentioned. Please feel free to ask any questions you have about it.

@aasthakourav20
Copy link
Author

Hey @Harshil-Jani , Sorry to say why did you closed this issue . I am still working on it and might have come with up something better . Last time due to some misunderstandings , wrong changes were made but would be more attentive this time .

@Harshil-Jani
Copy link
Member

Apologies @aasthakourav20 . Please make sure to proof-read AI content. I am still looking forward to see the Learn.md file. As of now don't worry about the README it has got things already enough and I believe in one of the issues somebody is already working on writing installation and setup.

You can spend some thoughts on LEARN.md file and make an improvement to the proejct.

@Harshil-Jani Harshil-Jani reopened this May 18, 2024
@aasthakourav20
Copy link
Author

Okay @Harshil-Jani , thank you so much for the opportunity . Will work upon learn.md file

@aasthakourav20 aasthakourav20 linked a pull request May 22, 2024 that will close this issue
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