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

Add LEARN.md #2

Closed
radville opened this issue May 16, 2022 · 1 comment
Closed

Add LEARN.md #2

radville opened this issue May 16, 2022 · 1 comment

Comments

@radville
Copy link
Contributor

radville commented May 16, 2022

Learn repos should have a LEARN.md file to teach another student how you created 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.

If your project is very large, consider just teaching a certain tool or implementation that your project utilizes.

@radville
Copy link
Contributor Author

Closing as complete ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant