This document serves as a summary for the GitHub Foundation Course, providing an overview of Git and GitHub, their definitions, and fundamental actions. It includes instructions for installation, basic commands, and using Git with SSH, HTTPS, and CLI. The guide also explains the purpose and usage of .gitignore files, pull requests, and issues along with their templates and explores GitHub features such as CODEOWNERS, Gists, GitHub Pages,Labels and GitHub Actions.
- Git and GitHub
- Fundamental Actions using Git
- Installation of Git and Github Desktop
- Git Basic Commands
- Git: SSH vs HTTPS vs CLI
- .gitignore File
- README.md File
- Pull Request
- Issues
- CODEOWNERS
- Gists
- Github Pages
- GitHub Actions
- Labels
Git is a distributed version control system that tracks changes to files and coordinates work on those files among multiple people. It allows for local and remote repositories, branching, and merging, enabling efficient and collaborative development.
GitHub is a web-based platform that hosts Git repositories, providing tools for version control, collaboration, and project management. It includes features like pull requests, issues, and CI/CD integration, enhancing team workflows and code sharing.
| Feature | Git | GitHub |
|---|---|---|
| Definition | Distributed version control system for tracking changes in source code | Web-based platform for hosting Git repositories and collaborating on projects |
| Main Purpose | Version control and source code management | Repository hosting, collaboration, and project management |
| Initial Release | 2005 | 2008 |
| Hosting | Local and remote repositories | Remote repositories |
| Interface | Command-line interface | Web-based interface with integrations to other tools and services |
| Additional Features | Branching, merging, rebasing, and more | Pull requests, issues, project boards, GitHub Actions for CI/CD, and more |
| Authentication | SSH keys, HTTPS, and CLI | Personal access tokens, OAuth, SSH keys, and SAML |
| Integration | Can be integrated with various CI/CD tools manually | Built-in CI/CD with GitHub Actions, integrates with many other tools and services |
Clone: Create a local copy of a remote repository from the Github.
Commit: Save changes to the local repository with a message describing the changes in form of tree.
Push: Upload local commits to a remote repository.
Pull: Fetch and merge changes from a remote repository to the local repository.
Branch: Create a separate line of development used to mulitple ways of development of the same repository at the same time .
Merge: Combine changes from different branches after dealing with conflicts to main branch.
Fork: Create a personal copy of someone else's repository on GitHub.
Issues: Track bugs, enhancements, or tasks related to the project.
https://git-scm.com$ sudo dnf install git-allhttps://github.com/apps/desktopgit init: Initialize a new Git repository.git clone [repository_url]: Clone an existing remote repository to your local machine.
git branch: List all branches in the repository.git branch [branch_name]: Create a new branch.git checkout [branch_name]: Switch to a different branch.git merge [branch_name]: Merge a branch into the current branch.
git status: Show the status of changes as untracked, modified, or staged.git add [file_name]: Stage changes for the next commit.git add .: Stage all changes in the current directory.git commit -m "[commit_message]": Commit staged changes with a descriptive message.
git push: Push local changes to the remote repository.git pull: Fetch and merge changes from the remote repository to your local repository.git fetch: Fetch changes from the remote repository without merging.
git log: Show commit history.
git merge [branch_name]: Merge changes from one branch to another.
- It Uses cryptographic keys for secure communication between your local machine and the remote server.
git clone [email protected]:user/repository.git- Uses the standard HTTP protocol with encryption, requiring a username and password (or a personal access token) for each interaction with the remote repository.
git clone https://github.com/user/repository.git- The tool you use to issue Git commands through your terminal or command prompt.
git clone [repository_url]
git commit -m "Commit message"
git push origin mainThe .gitignore file is a configuration file used by Git to specify which files and directories should be ignored and not tracked by version control.
A README file is an markdown file(.md) used to provide an overview of the project, including installation instructions, usage guidelines, and contribution information. It serves as the primary source of documentation for users and contributors. It helps in quickly understanding the project's purpose and how to get started with it.
A Pull Request (PR) is a method of submitting contributions to a project. It allows developers to notify project maintainers about changes they'd like to merge into the main codebase.
Creating a pull request (PR) template in GitHub helps standardize the information provided in PRs, making it easier for reviewers to understand the purpose and context of changes. Here’s how to set up and use a PR template in your GitHub repository.
The PR template file can be named PULL_REQUEST_TEMPLATE.md.
Write the Template:
- The template should include sections that guide contributors on what information to provide.
directory:
> .github/ └── ISSUE_TEMPLATE/ ├── bug_report.md └── config.yml
Common sections include:
- Description, Related Issue, Motivation and Context,, Screenshots, Types of Changes, Checklist, etc.
- Issues on GitHub are used to track tasks, enhancements, bugs, and other project-related work. They allow users and contributors to discuss and collaborate on these topics. Each issue can be tagged, assigned, and referenced in commits and pull requests to streamline project management.
Create or identify the issue:
- Open or find an existing issue you want to address.
Create a pull request:
- Make your changes in a new branch.
- Push the branch to your GitHub repository.
- Open a pull request and include a description.
Link the issue:
- In the PR description, use keywords like
Fixes #42,Closes #42orResolves #42to link and automatically close issue #42 when the PR is merged.
GitHub allows you to create issue templates that users can fill out when they create a new issue.you need to create a markdown file bug_report.md to define the template of your github isuue's template.
Header contents of ISSUE_TEMPLATE/bug_report.md file
---
name: Bug Report
about: Create a report to help us improve
title: "[BUG] "
labels: bug
assignees: ''
----A configuration file can be used to further customize the behavior of issue templates and forms using config.yml file.
- name: "Support"
url: "https://example.com/support".github/
└── ISSUE_TEMPLATE/
├── bug_report.md
└── config.yml
In GitHub, the CODEOWNERS file is used to define the individuals or teams responsible for code in a repository. When a CODEOWNERS file is present, GitHub uses it to automatically request reviews from the specified owners when someone opens a pull request that modifies the code they own.
Location:
The CODEOWNERS file can be placed in the root of the repository, in the .github directory, or in the docs directory.
Syntax:
Each line specifies a file pattern followed by one or more owners.
Owners can be GitHub usernames or teams in the format @organization/team.
Gists in GitHub are a way to share code snippets, notes, or any other text-based information. They can be public or private, and each Gist is a Git repository, which means you can clone, fork, and manipulate it like any other Git repository.
https://gist.github.com/
GitHub Pages is a feature that allows you to host static websites directly from a GitHub repository. It's a great way to publish personal sites, project documentation, or any other static content.
To create a static pages name the Repo as :
username.github.io
https://<username>.github.io/<repository-name>/
GitHub Actions is a powerful CI/CD (Continuous Integration and Continuous Deployment) platform that allows you to automate workflows directly within your GitHub repository. You can use GitHub Actions to build, test, and deploy your code based on specific events like pushes, pull requests, or scheduled times.
An Action Workflow YAML file(.yml) is created in
.github/workflows/
Labels in GitHub are used to categorize issues and pull requests, making it easier to manage and organize your project's workflow.
Common Labels:
- Status: bug, enhancement, help wanted, question.
- Priority: high,medium,low.
- Type: feature, documentation, refactor
Mastering Git and GitHub is essential for efficient version control and collaboration in modern software development. This Document helps you to equips with the foundational knowledge to effectively manage and contribute to projects.