You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Learn repos should have a LEARN.md file to teach another 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.
Since your project is large, consider just teaching a certain tool or implementation that your project utilizes.
The text was updated successfully, but these errors were encountered:
As this is kind of a huge task, can it be done at the very end? And some issues depend on LEARN.md, so can I create a blank one for now and move on with the rest of the issues?
I completely understand. It is a big ask given how large your codebase is.
I would recommend not worrying about this for your submission. You can submit a collaborate repo to start, and if you decide you want to teach students how to write portions of your code you can add LEARN.md later.
Learn
repos should have a LEARN.md file to teach another 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.Since your project is large, consider just teaching a certain tool or implementation that your project utilizes.
The text was updated successfully, but these errors were encountered: