If you have windows, you want to use the "powershell" application. If you use a Mac, you want to use the "terminal".
- cd ..: go back to the previous directory
- cd folder1: move inside folder1
- ls: list all the files in the current directory
- mkdir <folder_name>: make a folder with the name "folder_name"
- rm <file_name>: delete the file "file_name" permanently
- rm -r <folder_name>: delete the folder "folder_name" and all its contents permanently
- touch <file_name>: create an empty file
- Get a github account and accept the invitation from "uscmakers" important
- Go to https://git-scm.com/download/win and the download will start automatically.
- Download sublime with this link: https://www.sublimetext.com/3 (select the windows version)
- If you already have a text editor such as VS Code, BBedit, Notepad++, Atom, etc, feel free to skip this step
- Get a github account and accept the invitation from "uscmakers" important
- Run: <git --version> on your terminal. If you don't already have git installed, this will prompt you to install git.
- Download sublime with this link: https://www.sublimetext.com/3 (select the mac version)
- If you already have a text editor such as VS Code, BBedit, Notepad++, Atom, etc, feel free to skip this step
- In the command prompt/powershell, type these following commands. Make sure your email is your USC email, and make sure that your username is the username affiliated with your github.
git config --global user.name "Your name here"
git config --global user.email "your_email@example.com"
git config user.name "Some One"
git config user.email "email@email.com"
- Complete Installation, Crash Course, and Linking Github to the Terminal in this order. (If you have worked with git on your laptop, you may have to do none/some of the steps)
- Clone this repo:
- Navigate to the folder you want to copy this tutorial into using the crash course guide above (please use the command line!)
- Copy the address of the repo. Press the "code" button on the right top of the screen of the online github repo, and copy the address with ONLY https
- type "git clone <address_you copied in step 1b>"- you should see the repo in your file explorer now!
- Navigate inside of the cloned folder by typing "cd TutorialPractice".
- Pull Updates:
- In the command line, type "git pull" to pull all the updates from the upstream branch. Depending on when you do this, you might see other peoples' files load into your directory. This "refreshes" your local repository to reflect what the remote repository looks like.
- Create a Branch
- Go back into the command line, and type "ls" or "dir". You should be able to see a README.md, and potentially other people's names.
- Now, lets orient ourselves and check which branch we are on by typing "git status". You should see that you are on the master branch. By default, you start on the master branch.
- Lets create a new branch by typing "git checkout -b <branch_name>" PLEASE title your branch your full name. Ex. Radhika_Agrawal
- Type "git status" again. You should see that you are now on your newly created branch.
- Create a file
- Create a text file and name it your full name. Ex. Radhika_Agrawal.txt
- Open the file in your file explorer with Sublime (or editor of your choice)
- Write your name in the file!
- Save and close the file
- Upload your code to github
- Type "git add -A". "-A" means all files
- Type "git commit -m "type a message here"". -m means that you will attatch a message to associate your commit with. In this case, just type a generic message briefly describing what you will be uploading.
- Type "git push". This should give you an error saying that you have not specified an upstream branch.
- Copy what the error told you to type, which should be "git push --set-upstream origin <branch_name>". By doing this, you are setting where you will later be merging the branch to.
- Create a pull request on github
- Navigate back to the github website and refresh.
- Navigate to the "pull requests" tab
- You should see a button that says 'Compare and Pull Request'. Click on the button.
- Confirm that the "base" branch is Master, and the branch to be "compared" is your new branch.
- Title the pull request with your name Ex. Jenny's Pull Request. You can leave the comment section blank, or you can put some comment in it.
- NOTE: You can also add people in your team as reviewers to review the pull request in a real life situation!
- Merge your PR:
- You can merge your branch into master. Find your PR on the PR page, and merge it into the master branch.
- You will then be able to see your file on the master branch!
- git pull: pull updates from the upstream branch
- git pull origin master: pull updates specifically from the master head
- git add -A: add ALL the updates that were made in the local repo
- git add jenny.txt: add ONLY the updates that were made in jenny.txt
- git commit -m "write a message": commit the updates
- git push: push the updates from your local repo to your remote repo
- git push --set-upstream origin branch_name: push the updates to the remote repo AND set your upstream branch to master
- git status: check which branch you are on
- git checkout -b branch_name: make a new branch and switch branches
- git checkout branch_name: switch branches
- git branch --list: list the branches that you have on your local machine
- git branch -d branch_name: delete the branch
- git reset --soft HEAD~1: Undo one git commit (change the ~1 to ~5 if you want to undo the past 5 commits)
- git stash: Lets pretend that you were working on branch "avl" to work on avl trees. Even though you don't want to commit the code yet, you want to hop over to another branch to work another feature. You can save the work you were doing on the avl trees using stash.
- git stash list: List all the stashes you've stored
- git stash apply: You can re-apply the changes you've stashed back to your branch (most recent stash)
- git stash apply@{2}: Re-apply the second to most recent stash to your branches. (you can change the number to specify which stash you are talking about)