Skip to content

T00-git-and-github.md

Latest commit

 

History

History
53 lines (49 loc) · 3.02 KB

T00-git-and-github.md

File metadata and controls

53 lines (49 loc) · 3.02 KB

Git and Github (and Markdown)

Prep

  1. Read Chapter 1. Getting Started in the Pro Git book.
  2. Install git following the directions in section 1.5 of the Pro Git book.
  3. Complete the RealPython courses: Python Git and Github Intro
  4. Review 15 rules for communicating at GitHub
  5. Complete this markdown lesson and read Mastering Markdown (for Git).

Seminar Goals

Discuss what we learned about Git and Github and how it applies to the project.

Homework

  1. Fork and clone the turboPy-training repo
  2. Create a dev branch and commit/push some notes to the Notes section of this markdown file
  3. Create a pull request to merge your changes to turboPy-training main
  4. Coordinate with the other interns to divide and conquer to finish step 2 of the Seminar Workflow in the README file for all scheduled seminars.

Notes

  • Be sure to name branches and files logically and succinctly so as to minimize confusion between editors.
  • When forking the organization repository it is possible that not all branches will show up on your personal repository page. Double check that all branches appear on your local Git client and if they do then there shouldn't be an issue.
  • Always put a commit summary in the imperative form.
  • Make sure your local repo is up to date with the upstream to avoid merge conflicts.
  • Generally, it's not a good idea to commit directly to main. Instead, create a development branch and merge it with a pull request on github.
  • You can force a line break in markdown by putting two spaces, or a backslash, at the end of a line. Learned about it here.
  • You can also make text italicized or bold by surrounding the text with underscores or asterisks like so: *italics* or _italics_ and **bold** or __bold__.
  • Updating Fork (From upstream main branch):
# start in local main
git checkout main
# add remote for upstream
git remote add upstream https://github.com/NRL-Plasma-Physics-Division/turboPy-training.git
git fetch upstream
# merge the copied PPD main files in upstream to main
git merge upstream/main 
# push the changes to origin (your fork, implied)
git push 
# add remote for batman's iambatman repo
git remote add batman git@github.com:batman/iambatman.git
# fetch batman's code in iambatman
git fetch batman 
# switch to savegotham branch, naming it local-branch-name locally
git checkout -b local-branch-name batman/savegotham