Git Tutorial

[jjm469]

Make a basic git tutorial for C2S2 members.

[tomaschoi03]

This is a good tutorial I use ("Getting Started" page is helpful with examples): https://www.atlassian.com/git/tutorials

[UnsignedByte]

This already exists in conflucence under C2S2 Team Resources here, but is also not written and links to the ece4750 git tutorial. We should definitely flush this out, and cover

• Basic git commands
  • How to clone the repo
  • pushing/pulling
  • Creating branches (using make new_ip in our case) - this might mean we want to make a digital-specific tutorial on git instead?
  • switching between branches
  • How to merge branches
• Some github specific things
  • How to write an issue
    • What to include/not include in an issue title/description
    • How to label an issue
    • How to assign yourself to an issue
  • How to create a pull request
    • Linking issues to a pull request
    • How to request code review
    • How to review someone's code (how to leave comments, where to see files changed)
    • How to approve someone's code

Currently this is also not exactly the most accessible (pretty clear considering most of us, me included, didn't know this existed until today), so we should definitely provide links to it.

We should discuss whether to leave this on confluence or make a digital specific one and put it maybe elsewhere?

[jjm469]

Temporary tutorial

git add .

• do to add changes

git branch RouterJJM

• makes a new branch with name "RouterJMM"

git branch

• shows all branches. Active branches denoted with *

git checkout RouterJJM

• makes it so all changes about to be pushed are to the "RouterJJM" branch

git commit -m "Router"

• Every commit needs to have message so that is what -m "Router" is.

git push origin RouterJJM

• pushes changes to the branch RouterJJM.

git pull origin master

• Update local repo to match main.

*** Push to main or a branch
git add .
git commit -m "Notes on what changed"
git push origin [branch]

***Pull Request
git checkout -b "testbranch"
git push -u origin testbranch
(ON GITHUB): create new pull request