GitHub: Collaboration, Pull Requests & Portfolio

Use GitHub as a collaboration layer over Git and as a clear public record of technical projects.

Git and GitHub are related, but they are not the same thing.

Git     = version-control system
GitHub  = hosting + collaboration + review + automation around repositories

TipKey ideas

remote clone fork issue pull request review Actions README release Pages

Collaboration loop

Issue
 ↓
Branch
 ↓
Commits
 ↓
Push
 ↓
Pull Request
 ↓
Review
 ↓
Merge

Learn interactively

GitHub Skills:
https://skills.github.com/

GitHub Get Started:
https://docs.github.com/en/get-started

GitHub Actions:
https://docs.github.com/en/actions

GitHub Pages:
https://docs.github.com/en/pages

A Data Science repository should explain itself

project/
├── README.md
├── data/          # or instructions to obtain data
├── notebooks/
├── src/
├── tests/
├── requirements.txt
└── results/

A strong README answers:

1. What problem does this solve?
2. What data is used?
3. How do I run it?
4. What did you find/build?
5. How is the repository organized?

TipPortfolio principle

Three understandable, reproducible projects usually communicate more than dozens of unexplained notebooks.