Intro to git

Block 4.2: Final Bits

Jan Simson

Contributing to Open-Source

• Don’t be scared to make your own work public
• If you see a project on GitHub you want to contribute to, just comment on an issue
  • People are often happy about contributions
  • It can be a lot of work to maintain a busy project though, so also expect that
• There are also events like: Hacktoberfest

Licenses

• Repositories often have a LICENSE file at their root
• This indiciates the LICENSE the code is under and how you are allowed to use it
• If you make your own code / repository public, make sure to pick a proper license
• To help you pick a license: https://choosealicense.com/

Making your Repository Citeable

• You can assign a doi (digital object identifier) to your repository using Zenodo
  • Steps are outlined in this guide
• You can also add an official CITATION file, so people know how to cite the repository
  • Steps are outlined in this guide

Advanced Github

• You can easily start an in-browser version of VSCode on github
  • Just change URL from https://github.com to https://github.dev
  • Or press the . key, inside a repository
• You can automatically run code via GitHub Actions
• You can get all sorts of goodies via the GitHub Student Pack

Advanced Github: Pages

• One of the coolest features of GitHub is that you can host your own website there for free
• This service is called GitHub Pages
• You can create websites for specific projects (i.e. repositories)
  • <your_gh_username>.github.io/<your_repo_name>
• Special repository name: <your_gh_username>.github.io
  • To create a personal website

Final Summary

• Initialize a repository with git init
• Stage your files with git add
• Whenever you made a substantial change, put it into the history with git commit
• See your history with git log
• Move around (history and branches!) with git checkout
• Create new branches with git checkout -b
• To collaborate, first git pull others changes, then git push yours

Going Beyond

Guides to Re-Visit

Most of the information in these guides, we already covered, but they can be great if you want to re-visit anything.

• https://learngitbranching.js.org/
• https://github.com/git-guides
• Introduction to RStudio Git & GitHub
• The Carpentries: Version Control with Git
• https://gitimmersion.com

Git Game

Further Reading

• Popular Workflow: Trunk Based Development
• Good guide: Beej’s Guide to Git
• Using git with data
  • git lfs
  • dvc: Data Version Control
• If you have a problem
  • ohshitgit.com (🇩🇪)
  • Google

End of Block 🎉

Any Questions?

[🏡 Back to Overview]

[⏩️ Next Block]