jfmartinz / ResourceHub

ResourceHub is an open-source project that serves as a one-stop repository of valuable resources curated by the amazing contributors in the community🚀
https://resourcehubdev.vercel.app/
MIT License
130 stars 287 forks source link

Learn.md #124

Open Princegupta101 opened 1 month ago

Princegupta101 commented 1 month ago

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

devidutta-learn commented 1 month ago

Kindly assign me issue #124, GSSOC '24 contributor

jfmartinz commented 1 month ago

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

Is it really necessary to create this md file? I actually have provided the step by step process on how to install and use it in their local computer, which is located in the How to Contribute, I think that I dont need the learn.md since my project is not that complex for beginners not to understand.

jfmartinz commented 1 month ago

But I appreciate this suggestions, thank you!

Mahimatestgithub commented 1 month ago

I would like to work on this issue. Please assign me this issue.