Git & GitHub Documentation
Lesson 2. Introduction to git and GitHub
- git?
- git is a version control software
- It keep track of code changes
- It helps to collaborate in a project
- It is installed and maintained locally
- It provides Command Line Interface (CLI)
- Released in April 7, 2005
- Developed by Linus Torvalds & Junio C Hamano
- github?
- GitHub is a hosting service where we can keep our git repositiory/folders
- It is maintained on cloud/web
- It provides Graphical User Interface (GUI)
- Founded in 2008
Lesson 3. How to set git environment and configuration
- Download and install git on your pc: https://git-scm.com/
- check git version: open terminal or cmd then use the command
git --version
to find out whether git is installed or not. if git is installed it will return a version number of git.
git configuration
- check all configuartion options:
git config
- set global user name and user email for all repository/git folders (if you want to set different username and email for different git repository then remove --global)
- set global user name:
git config --global user.name "anisul-islam"
- set global user email:
git config --global user.email "anisul2010s@yahoo.co.uk"
- set global user name:
- list all git configuration:
- list all the configuration:
git config --list
- list user name:
git config user.name
- list user email:
git config user.email
- list all the configuration:
- change global username & email
- change global user name:
git config --global user.name "PUT_NEW_USER_NAME_HERE"
- change global user email:
git config --global user.email "PUT_NEW_USER_EMAIL_HERE"
- change global user name:
Lesson 4. creating git repo and adding new files
- creating a git folder
-
ls -a : list all files inside of a directory
mkdir DIRECTORY_NAME_HERE cd DIRECTORY_NAME_HERE git init Example: mkdir notes cd notes git init ls -a
- adding new files in git folder
-
git status : displays the state of the working directory and staging area
ls -a touch fileName.extension open fileName.extension git status Example: touch day1.txt open day1.txt write something inside the file
-
Git is aware of the file but not added to our git repo
-
Files in git repo can have 2 states โ tracked (git knows and added to git repo), untracked (file in the working directory, but not added to the local repository)
-
To make the file trackable stagging or adding is required
Lesson 5. how to add files in staging area & remove files
- adding files to stagging area:
git add fileName
add a file in staging area / indexgit add .
add all files of directory to stagging area not subdirectorygit add -A
add all files of directory and subdirectory to stagging areagit rm --cached fileName
unstage a file from staging areagit diff
- checking the differences of a staged filegit restore fileName
- restore the file
Lesson 6. practice-1
Lesson 7. commit & uncommit
git commit -m "message"
move the file to local repository from stagging areagit log
check the commit historygit reset --soft HEAD^
uncommit the commit in HEAD and move to staging areagit reset HEAD^
uncommit the commit in HEAD and move to unstaging / working areagit reset --hard HEAD^
uncommit the commit in HEAD and delete the commit completely with all the changes
Lesson 8. git HEAD and undo theory
git log --oneline
git show
git show HEAD^
git show commit-id
git checkout commit-id
git checkout master
Lesson 9. git HEAD and undo practical
Lesson 10. git revert
Lesson 11. git ignore
- create a .gitignore file and add the things you do not want to add in the stagging area
- Inside .gitignore we can keep secret files, hidden files, temporary files, log files
secret.txt
secret.txt will be ignored*.txt
ignore all files with .txt extension!main.txt
ignore all files with .txt extension without .main.txttest?.txt
ignore all files like test1.txt test2.txttemp/
all the files in temp folders will be ignored
Lesson 12. how to create github repository and commits
- sign in to your github account
- create a git repo
Lesson 13. README.md
-
Everything you need to know about README.md is discussed in the video.
-
6 heading levels: number of hashes define heading levels. check the following examples:
# heading 1 level text is here
## heading 2 level text is here
-
bold syntax:
**text goes here**
-
italic syntax:
_text goes here_
-
bold and italic syntax:
**_text goes here_**
-
strikethrouh syntax:
~~this is~~
-
single line code syntax: `` place code inside backticks
-
multiple line code syntax: ``` place code inside three open and closing backticks
-
multiple line code syntax language specific: ```html for specific lanaguage use language name when starting; not closing
-
Ordered List syntax
``` 1. HTML 2. CSS 1. Fundamental 2. CSS Architecture - BEM 3. CSS Preprocessor - SASS 3. JS ```
-
Unordered List syntax ->
- html - css - Fundamental - CSS Architecture - BEM - CSS Preprocessor - SASS - js
-
Task List
- [x] Task1 - [x] Task2 - [x] Task3
-
adding link
<!-- automatic link --> http://www.studywithanis.com <!-- markdown link syntax --> [title](link) [studywithanis](http://www.studywithanis.com) [studywithanis][websitelink] <!-- all link is here --> [websitelink]: http://www.studywithanis.com
-
adding image syntax ->
![alt text](imageURL)
![1800 milestone](https://i.postimg.cc/qvZpmxKF/1-800-Uploads-Milestone.png)
-
adding emoji
emoji src ### Smileys ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐คฃ ๐ฅฒโบ๏ธ ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐ฅฐ ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐คช ๐คจ ๐ง ๐ค ๐ ๐ฅธ ๐คฉ ๐ฅณ ๐ ๐ ๐ ๐ ๐ ๐ ๐โน๏ธ ๐ฃ ๐ ๐ซ ๐ฉ ๐ฅบ ๐ข ๐ญ ๐ค ๐ ๐ก ๐คฌ ๐คฏ ๐ณ ๐ฅต ๐ฅถ ๐ฑ ๐จ ๐ฐ ๐ฅ ๐ ๐ค ๐ค ๐คญ ๐คซ ๐คฅ ๐ถ ๐ ๐ ๐ฌ ๐ ๐ฏ ๐ฆ ๐ง ๐ฎ ๐ฒ ๐ฅฑ ๐ด ๐คค ๐ช ๐ต ๐ค ๐ฅด ๐คข ๐คฎ ๐คง ๐ท ๐ค ๐ค ๐ค ๐ค ๐ ๐ฟ ๐น ๐บ ๐คก ๐ฉ ๐ป ๐ โ ๏ธ ๐ฝ ๐พ ๐ค ๐ ๐บ ๐ธ ๐น ๐ป ๐ผ ๐ฝ ๐ ๐ฟ ๐พ### Gestures and Body Parts ๐ ๐ค ๐ โ ๐ ๐ ๐ค ๐ค โ๏ธ ๐ค ๐ค ๐ค ๐ค ๐ ๐ ๐ ๐ ๐ โ๏ธ ๐ ๐ โ ๐ ๐ค ๐ค ๐ ๐ ๐ ๐คฒ ๐ค ๐ โ๏ธ ๐ ๐คณ ๐ช ๐ฆพ ๐ฆต ๐ฆฟ ๐ฆถ ๐ฃ ๐ ๐ฆป ๐ ๐ซ ๐ซ ๐ง ๐ฆท ๐ฆด ๐ ๐ ๐ ๐ ๐ ๐ฉธ
-
adding table
table syntax | heading1 | heading2 | | ----- | ----- | | data1 | data2 | | data3 | data4 | | data5 | data6 |
Lesson 14. Connecting local repo to remote repo
- check remote connection:
git remote
orgit remote -v
git remote add name <REMOTE_URL>
example: git remote add origin http://...- to clone a remote repository:
git clone <REMOTE_URL>
Lesson 15. push and pull
- push a branch
git push -u origin branch_name
- push all branches
git push --all
- pull from a repo:
git pull
which is equivalent to git fetch + git merge
Lesson 16. branching and merging
- Branch is a new and separate branch of master/main repository
- create a branch
git branch branch_name
- List branches
git branch
- List all remote branches
git branch -r
- List all local & remote branches
git branch -a
- move to a branch
git checkout branch_name
- create and move to a branch
git checkout -b branch_name
- delete a branch:
git branch -d branch_name
- merge branches:
git checkout branchName git merge branchName
git log --oneline --all --graph
Lesson 17. branching and merging locally
Lesson 18. git and GitHub practice - 2
Lesson 19. GitHub Issues
Lesson 20. 2-way and 3-way merges
- Reeference:
Lesson 21. Merge Conflicts
Lesson 22. Tags
In GitHub, "tags" typically refer to Git tags. Git tags are a way to mark specific points in a Git repository's history as being important or significant. They are often used to label specific commits, such as releases or version numbers, to make it easier to reference those commits in the future.
Here's how Git tags work:
-
Creating a Tag: You can create a Git tag by running a command like
git tag <tag-name>
, where<tag-name>
is the name you want to give to the tag. For example, you might create a tag for a release like this:git tag v1.0.0
. -
Tagging Commits: Tags are typically associated with specific commits. When you create a tag, it's linked to the current commit, but you can also specify a different commit if needed.
-
Listing Tags: You can list all the tags in a Git repository using the
git tag
command. -
Annotated vs. Lightweight Tags: Git supports two types of tags: annotated and lightweight. Annotated tags are recommended for most use cases because they store extra metadata like the tagger's name, email, date, and a tagging message. Lightweight tags are just a name for a specific commit and don't include extra information.
-
Pushing Tags: By default, when you push changes to a remote Git repository, tags are not automatically pushed. You need to use
git push --tags
to push tags to a remote repository. This is important when you want to share tags, especially when creating releases on GitHub. -
Using Tags on GitHub: On GitHub, you'll often see tags associated with releases. When you create a release on GitHub, it typically creates a Git tag behind the scenes to mark the specific commit associated with that release. Users can then download or reference that release by its tag name.
GitHub also has its own concept of "releases" that are closely related to Git tags. A release on GitHub is a way to package and distribute software versions, and it often corresponds to a Git tag. When you create a GitHub release, you can upload release assets (e.g., binaries, documentation) and provide release notes.
In summary, GitHub tags are essentially Git tags, and they are used to mark important points in a repository's history, often associated with releases or significant commits. They help users easily reference and work with specific versions of a project.