Sharing Your Side Projects Online and Making Your Github the Best Résumé It Ca
summary
Practical checklist for turning side projects into readable, runnable repos: make a clear README-driven development front page, add a license, declare dependencies with an environment.yaml or requirements file (Conda recommended), include runnable Jupyter notebooks and a mybinder.org badge, provide setup.py/pip install instructions, package small CLIs with click, and use cookiecutter templates so projects install cleanly, document how to run examples, and actually automate a reproducible demo rather than just listing features.
AI-written summary · about
chapters (15)
- 0:00Sharing side projects matters
- 5:37Git and GitHub basics
- 7:45GitHub as resume
- 9:08Writing README files
- 11:13Licensing code properly
- 13:20Jupyter notebooks for examples
- 17:12Interactive code with Binder
- 19:21Engineering side projects
- 23:36Declaring dependencies
- 27:09Idiomatic Python code
- 28:56Feedback from peers
- 30:21Command line tools
- 32:07Python packages installable
- 33:55Automating with Cookiecutter
- 38:33Q&A
related talks
35mThe Art of Documentation and Readme.md for Open Source Projects
47mThe Art of Documentation and Readme.md
26mOpen Source on Easy Mode
20mImprove project usability and reduce friction
25mHi, my name is README!
32mGit yourself a leg up for student projects
49mExplain Yourself! Documentation for Better Code
50mIf you're techie, your homepage should be GitHub, not Instagram!