Git & Github Cheatsheet: Creating Repo
Git & Github Cheatsheet: Creating Repo
Table Of Contents
Creating repo
Staging
Commiting & Stash
Gitignore
Reverting & Reset
Branches
Merging branches & Conflicts, Rebasing
Github
Git Config :
git config -- global user.name NAME || git config --global user.email EMAIL = to set info
git config user.name || git config user.email = to check info
Creating repo
git init = creates a git repository in the directory currently in
Staging
git status = to check status , if staged or unstaged
git add FILE_NAME = to add a file to staging area
git rm --cached FILE_NAME = to remove a file from staging area
git add . = to add all files in project to staging area
Commiting
git commit -m "Specific Changes Made" = commits the staging area giving them a specific id
git log --oneline = shows all the commits in one line each
Git Stash
git stash = clears the changes to the initial state (last commit) & creates a unique id for the current state
git stash apply = brings back the current state
using git stash multiple times creates a list of stashes of all states with multiple ids
git stash list = shows all the stash (States) with their ID
git stash apply ID = ID will be the number , which state you want to go back to
git stash push -m "Your message" = used to give description to stash
git stash drop ID = used to remove a stash saved
git stash pop ID = applies the specific stash and removes it from history
git stash clear = removes all the stash history
Gitignore
a .gitignore file can be created , in which you can specify all the folders/files that should not be staged and commited
For example : node_modules/ .css.map etc.
It's Good to create a gitignore at the start of Project
a good gitignore generator for reference :
Gitignore.io (https://www.gitignore.io/)
Checkout commit :
git checkout commit_ID = to just check the commit id entered , see it in read only ... changes will not be saved
git checkout master = to come back to original commit (As checkout removes us from master branch)
Revert commit :
git revert commit_ID = to remove the changes of the provided commit (will add a new revert commit and remove the changes of the specific commit)
Reset Commit :
git reset commit_ID = will remove all the commits after the provided id , but the files in local directory will not be touched (therefore you can still commit to
original state after doing changes as needed) ... might take you to vim editor (type ":wq" then "Enter" to exit)
git reset commit_ID --hard = will remove all the commits after the provided id and even delete all the files and lines from local directory too
Branches
Used to test a new feature or code , by creating a branch .. then merging it to master only if needed
can be used for multiple developers working on same project .. create different branch for each developer adding their own feature then merging at the end
git branch branch_name = to create a new branch
git branch -a = to list all the branches
git checkout branch_name = to shift to the other branch
git branch -d branch_name = to delete the branch only when it has been merged
git branch -D branch_name = to delete the branch (even if not merged to master)
git checkout -b branch_name = to create and shift to a new branch at once
Merging branches
after completing changes in a branch and commiting them
git merge branch_name = this will merge the branch to master (all commits show in master) = automatic
git merge --squash branch_name = this will merge the branch to master (only the commit after merge is shown in master) = manual
Conflicts
If Branch's Base (First Commit) is Master's Head (Last Commit) = No Conflict
to solve this , edit the files manually , Solve The Conflicts then ..
run git add . and then git commit -m "Message" and the changes will be made
whereas Git Rebase keeps changing the base, and makes the commit inline , feels like the branch was never there
1. Takes the base of master , matches it with every commit of your branch
7. Move to Master
9. Now All the commits of Branch are added above your Master commits
NOTE! : It is specified in the git docs that rebase should not be used in public repos (collaboration) as it can cause major errors and conflicts, it can be used in private repos.
Github
Creating new & Cloning Repo
create a new repo on Github and copy the URL
git push git_url master = pushing code to master (master can be replaced by any other branch_name or for all branches replace master with --all)
git remote add origin git_url = origin can be name of anything else, but origin is the word most commonly used
git push -u origin master = pushes and starts tracking the branch (u don't need to specify it again , ex. if pulling)
git clone git_url = will copy the repo to current directory and also add the origin alias by default
to avoid this you can remove the password and enter it later
git push https://username@repo_url.git master
Collaborating
Most of the collaboration features are already available on Github, Example
1. git pull git_url = to pull changes from remote to local repo
2. create a branch and make your changes
3. git push origin branch_name = to push the specific branch to remote
4. create a Compare & Pull Request when you want are ready for the branch to be merged (with a message)
5. the reviewer of the repo will accept the changes and merge it (and specify a merge commit message)
6. pull the project every time before editing to see the changes
git branch -r = helps us to see the remote branches & the connections
Forking (Contributing)
to contribute to an open source project
click on fork , which will copy the repo to your account
make changes by pulling the repo, then push it ( this will happen on your account )
then go to the owner account's repo and create a pull request there
the owner can compare the changes and accept your changes
which will end up merging your changes to their project