search

hbctraining / reproducibility-tools

https://hbctraining.github.io/reproducibility-tools/
7 stars 7 forks source link

Add a lesson on branches #5

Open mistrm82 opened 1 month ago

mistrm82 commented 1 month ago

For the next iteration of the workshop

hwick commented 1 month ago

Here is a potential outline for branching lesson:

LO: Learn what a branch is and what they are useful for Learn how to create a branch and switch between branches in GitHub Desktop Learn how to make changes to branches in GitHub Desktop Learn how to merge branches in GitHub Desktop Explore branch management on GitHub.com

What is a branch?

very basic info on utility of branches: https://docs.github.com/en/desktop/overview/getting-started-with-github-desktop#making-changes-in-a-branch

more detailed info on branches: https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell

How to create a branch in GitHub Desktop, switching between branches, and making changes

creating a branch: https://docs.github.com/en/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop

choosing a branch and creating changes: https://docs.github.com/en/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop

Cherry picking commits to a branch/creating branch from a commit? (mentioned at the very end of the previous lesson)

NOTE: creating changes section has useful info on discarding or choosing specific bits of changes within a commit which might be useful to add to the original lesson material on commits eventually (can also just be mentioned by teacher during class)

How to merge branches:

https://docs.github.com/en/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop#about-managing-branches

How to create and merge branches on GitHub.com

Summarize above but on GitHub.com