In this repo we will practice using branches, committing code, and opening pull requests (PRs) by checking in your information! 🚀🚢
- make sure you have Git installed and are logged in to your GitHub account on Git
- you can either use the Git command line or the GitHub Desktop app. If you're using GitHub Desktop make sure you have it installed from here.
- you have some kind of text editor. We recommend VSCode, install it here
- Clone this repository. Click the green
Codebutton.- GitHub desktop: click
Open with GitHub Desktopand that should take you to the desktop application and ask where to save things. Once you're done hitClone. - Git command line: run
git clone <url>where<url>is the HTTPS url of the repo in the input box.
- GitHub desktop: click
- Create a branch named
<netid>with your NetID.- GitHub desktop: Do CMD+N or click the
Current Branchtab on top and thenNew Branch. - Git command line:
git checkout -b <netid>
- GitHub desktop: Do CMD+N or click the
- Open the repository in your text editor.
- GitHub Desktop: click
Open with VSCode - Git command line, navigate to the folder you cloned the repo in and open it in VSCode or your favorite text editor
- GitHub Desktop: click
- Create a file named
<netid>.mdwhere<netid>is your Cornell NetID. - Copy the contents of
my474.mdinto your new file. This is Megan's profile information but you'll populate it with your information :) - Remove all of Megan's information (but keep the labels!) and enter your information instead. Don't forget to save!
- Add and commit your changes.
- GitHub Desktop: fill in the commit message (input box with default text
Update README) and click the blueCommit to <netid>. TheDescriptioninput is optional. - Git command line: run
git add <netid>.mdand thengit commit -m "<msg>"where<msg>is your commit message
- GitHub Desktop: fill in the commit message (input box with default text
- Push your changes.
- GitHub Desktop: Click
Publish branchbutton on the top tabs. - Git command line:
git push -u origin <netid>
- GitHub Desktop: Click
- Create a pull request
- GitHub Desktop: Click the
Create pull request button. - Go to https://github.com/HackOurCampus/git-workshop and (if you are logged in) you should see a prompt in yellow with your branch name and a green button
compare and pull request. Click that.
- GitHub Desktop: Click the
- Fill out pull request
- Add a title and description on the web interface! Be sure the title has your name and netid :)
- Wait for @meganyin13 approval review! 👩🏻💻
- Once you've received approval, click
squash and merge.
You have now learned the Git workflow and created a pull request (PR)! See you at the hackathon!