https://github.com/vindecodex/gitguide
Guide for Git
https://github.com/vindecodex/gitguide
git guide
Last synced: about 1 year ago
JSON representation
Guide for Git
- Host: GitHub
- URL: https://github.com/vindecodex/gitguide
- Owner: vindecodex
- License: mit
- Created: 2019-06-28T01:14:25.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-11-17T02:03:24.000Z (over 5 years ago)
- Last Synced: 2025-04-13T19:59:16.335Z (about 1 year ago)
- Topics: git, guide
- Homepage:
- Size: 80.1 KB
- Stars: 3
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
***
## ~/.gitconfig
> Configure username
``` php
$ git config --global user.name "[name]"
```
> Configure email
``` php
$ git config --global user.email "[email address]"
```
## Remote
`git remote` - to display remote associated by the repository.
`git remote add ` - to add a remote repository. for more [checkout](/tips.md)
> Listing Remote
`git remote`
> Deleting a Remote
`git remote rm [remotename]`
***
## Create New Repository
1. Create Repo on Github
2. `git init` on local directory
3. copy repo url (use the ssh)
4. `git remote add origin [repo url you copy on step 3]`
5. `git add .`
6. `git commit -m "your message"`
7. `git push origin master` (if got Permission Error try [this](https://github.com/vindecodex/gitguide/blob/master/fixPermisionError.md))
8. To add Security on commiting you can follow this [guide](https://help.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key)
8.1. If you done assigning gpg key to your github, dont forget to tell git about your gpg by doing these:
```php
$ git config --global user.signingkey
$ git config --global commit.gpgsign true
```
## Or Download Existing Repo
``` php
git clone [urlofrepo]
```
***
## Create branch and merging branch to the master
>You can create branch to create/upgrade/edit the existing file without affecting the main/master branch
```php
$ git branch branchname
```
>To enter to our new branch
```php
$ git checkout branchname
```
>You can checkout different branch created by anyone on your project
```php
$ git add .
$ git commit -m "Your message here"
$ git push origin branchname
```
>Adding new files in our branch
>After pushing to origin branchname a link will be given to the terminal, click it while pressing cmd on mac, i think ctrl for windows
>It will redirect to the pull request on github page
>Click Create pull request
```php
$ git checkout master
```
>To go back to the master branch
```php
$ git merge branchname
$ git push origin master
```
>To merge our changes on our branch to the master
>And push to our master to fully added to the main project
***
## Check for changes
```php
$ git status
```
>check if there is added, deleted or modified files so that you can start running the `git add` and `git commit`
```php
$ git diff
```
>to see changes of files that are not yet added by `git add .` to the master branch
```php
$ git diff branchA branchB
```
>to see changes between two branches
```php
$ git diff --staged
```
>to see changes of files that are already added by `git add .` to the master
>after you `git add .` those files are in staging or ready to be commited
```php
$ git reset filename
```
>to unstage the files but the contents of your current work will not be affected, it will just remove the added files for staging
```php
$ git log
```
>display all commited versions
```php
$ git log -1
```
>display only the last commit
## Rebase
>if you commited two times and the last commit just had a few changes and doesnt deserve to be commited then we can delete it without affecting the contents, only the commit will be removed but not its content or it will merge the last commit to the first commit
```php
$ git rebase -i HEAD~n //n here represents a number of how many commits will be modified
```
>if you want the commit will not be added but only its content we use this
>example we just commited for one time and push it to repo and then we update just a few code because got a wrong spelling then commit again, then its not really deserve to be commited.
```php
$ git rebase -i HEAD~2
```
```
yellow is the action
light blue is the commit code
pink is the commit message
```
>we want to merge committed A content to the add edit commit because A has just a few changes and it doesnt need to be commited
>**pick** is for the commited
>**f** is for **fixup**
>when using fixup you need HEAD\~2 or greater than 2 because you need one commit to merge the other one, you cannot use fixup if only HEAD\~1
>to edit the files is press **i**, and press **esc** to leave edit mode and press **:(shift ;)** then press **wq** for write quite
```php
$ git push origin master -f
```
>to push our changes to repo we need to add -f because we used rebase, remember always when using rebase you need to add -f when pushing
>**d** for **drop**
>this will delete the commited and also the contents entirely
```php
$ git push origin master -f
```
>if your branch is out of date or not the latest version from the origin master and to avoid build errors, ci errors, conflicts
```php
$ git fetch origin //fetch latest origin
$ git rebase origin/master
```
>now you are now top of the latest version!
***
# Git Add
>commit specific file
```php
$ git add [filename]
```
>commit all in a directory
```php
$ git add .
```
>commit everything included sub directories
```php
$ git add . -A
```
***
# Commit
>add to staging
```php
$ git commit -m "you message"
```
>add another file from previous commit/staging
```php
$ git add [file you want to add from previous commit]
$ git commit --amend
```
>it will prompt for a new commit message
>Uncommit Committed Files
```php
$ git reset HEAD~
```
# Show Sorted Branch
>Get a list of branches ordered by most recent commit
>use the `--sort=-committerdate` option of [git for-each-ref](https://mirrors.edge.kernel.org/pub/software/scm/git/docs/git-for-each-ref.html)
```php
$ git for-each-ref --sort=-committerdate refs/heads/
```
>or using git branch (since version 2.7.0)
```php
git branch --sort=-committerdate # DESC
git branch --sort=committerdate # ASC
```
***
# Fetching (Don't Care Local Changes)
> Be sure to stash all your local changes because it will be deleted when doing these.
> This will be a fresh files from repo (to avoid cloning again and again)
```php
$git fetch --all
$git reset --hard origin/master
```
***
# Other way on cleaning local and fetching latest repo
> To remove the committed files on your local
```php
$ git reset --hard HEAD^
```
> To remove the uncommitted files on your local
```php
$ git clean -fd
```
> You can choose one of the command above or do it both according to your needs.
> After running above commands run below command
```php
$ git pull
```
***
# Stash
>git stash is to set aside what you are editing then go back to it later
>if you had edit something then want to reset but you want it to be save you need to use **stash**
```php
$ git stash
```
>now you stash you local modification
>and now you edit alot but want to go back from what you stash lately.
```php
$ git stash pop
```
>this will pop the latest stashed
>if you stashed alot you can use
```php
$ git stash list
```
>to drop or delete a stash you can use
```php
$ git stash drop
```
>this will delete latest stashed
>to get the specific stash
```php
$ git stash pop stash@{n}
```
***
# Updating Forked repo
```php
// create a new remote from original repo
$ git remote add upstream [ssh or https url of the repo]
```
```php
// fetch from that original repo
$ git fetch upstream
```
```php
// rebase from that original repo branch [master or main]
$ git rebase upstream/master
```
```php
// push your updated local branch to your forked repository
$ git push origin master --force
```
***
# Creating Alias
[Creating Aliases](https://github.com/vindecodex/bashrc)
# Passing Commits to another branch
```php
// on your branch that holds the commit you want to pass
$ git log
// copy the commit hash found
$ git checkout [branch that will copy the commit]
$ git reset --hard [hash of the commit you want to copy from the other branch]
// remove the [brackets]
```
# Renaming Branch from local and remote repository.
```php
// head must be on your old branch when doing this.
$ git branch -m [new branch name]
// renaming local branch
$ git push origin -u [new branch name]
// delete remote branch
$ git push origin --delete [old branch name]
```
# Multiple Git Users with SSH
[Follow this Guide](/multiple-git-users-with-ssh.md)
### Guide on Contributing
1. Fork this repo.
2. Create a branch
3. Push you changes
4. Create a PR
# Other useful tips
[TIPS](/tips.md)
***
>If you see something that needs improvement please help by creating a pull request. I also suggest play git **[here](https://learngitbranching.js.org/)**
***