git-and-github-for-beginners.ipynb

{"metadata":{"kernelspec":{"language":"python","display_name":"Python 3","name":"python3"},"language_info":{"name":"python","version":"3.10.12","mimetype":"text/x-python","codemirror_mode":{"name":"ipython","version":3},"pygments_lexer":"ipython3","nbconvert_exporter":"python","file_extension":".py"},"kaggle":{"accelerator":"none","dataSources":[],"dockerImageVersionId":30635,"isInternetEnabled":true,"language":"python","sourceType":"notebook","isGpuEnabled":false}},"nbformat_minor":4,"nbformat":4,"cells":[{"cell_type":"markdown","source":"# Table of Contents\n\n1. [Introduction to GitHub](#1)\n   * [1.1. What is GitHub?](#1.1)\n   * [1.2. Why use GitHub?](#1.2)\n   * [1.3. Set up a GitHub account](#1.3)\n   \n\n2. [Install Git](#2)\n   * [2.1. Install Git on Windows](#2.1)\n   * [2.2. Install Git on macOS](#2.2)\n   \n\n3. [Create New Repository](#3)\n   \n\n4. [Basic Git Commands](#4)\n   * [4.1. Initialize a New Repository](#4.1)\n   * [4.2. Clone a Repository](#4.2)\n   * [4.3. Stage Changes](#4.3)\n   * [4.4. Commit Changes](#4.4)\n   * [4.5. Check the Status of Repository](#4.5)\n   * [4.6. View Commit History](#4.6)\n   \n\n5. [Branching and Merging](#5)\n   * [5.1. Create a New Branch](#5.1)\n   * [5.2. Switch Between Branches](#5.2)\n   * [5.3. Merge Branches](#5.3)\n   \n\n6. [Collaborate on GitHub](#6)\n   * [6.1. Fork a Repository](#6.1)\n   * [6.2. Make Changes and Create a Pull Request](#6.2)\n   * [6.3. Review and Merge Pull Requests](#6.3)\n   * [6.4. Sync Your Fork with the Original Repository](#6.4)\n   \n\n7. [GitHub Issues and Projects](#7)\n   * [7.1. Create Issues](#7.1)\n   * [7.2. Associate Issues with Commits](#7.2)\n   * [7.3. Use GitHub Projects for Task Management](#7.3)\n   \n\n8. [Additional Resources](#8)\n   * [8.1. GitHub Documentation](#8.1)\n   * [8.2. Git Documentation](#8.2)\n   * [8.3. GitHub Learning Lab](#8.3)","metadata":{"_uuid":"8f2839f25d086af736a60e9eeb907d3b93b6e0e5","_cell_guid":"b1076dfc-b9ad-4769-8c92-a6c4dae69d19"}},{"cell_type":"markdown","source":"<a id = \"1\"></a>\n# 1. Introduction to GitHub\n\n<a id = \"1.1\"></a>\n### 1.1. What is GitHub?\nGitHub is a platform for version control and collaborative software development. It allows multiple contributors to work on projects simultaneously, keeps track of changes and enables collaboration.\n\n<a id = \"1.2\"></a>\n### 1.2. Why use GitHub?\nGitHub simplifies collaboration by providing a centralized location for code storage, issue tracking and project management. It ensures version control, collaboration and maintenance of a well-organized codebase.\n\n<a id = \"1.3\"></a>\n### 1.3. Set up a GitHub account\nCreate a github account first. Visit github.com and follow the account creation process.\n\n\n<a id = \"2\"></a>\n# 2. Install Git \n\n<a id = \"2.1\"></a>\n### 2.1. Install Git on Windows\n1. Download git for Windows from [here](https://git-scm.com/downloads).\n2. Run the downloaded executable file and follow the installation steps.\n\n<a id = \"2.2\"></a>\n### 2.2. Install Git on macOS\n1. Download git for macOS from [here](https://git-scm.com/downloads).\n2. Open terminal and check if git is installed by typing `git --version`.\n\n\n<a id = \"3\"></a>\n# 3. Create New Repository\n  - Click the \"+\" icon in the upper right corner.\n  - Select \"New repository\".\n  - Provide a name for your repository, a brief description and initialize it with a README if needed.\n  - Click \"Create repository\".\n\n\n<a id = \"4\"></a>\n# 4. Basic Git Commands\n\n<a id = \"4.1\"></a>\n### 4.1. Initialize a New Repository\nTo initiate a new git repository within your project, use `git init`. This command sets up a new git repository in the current directory.\n\n<a id = \"4.2\"></a>\n### 4.2. Clone a Repository\nTo clone a remote repository to your local machine, use `git clone <repository_url>`. Replace `<repository_url>` with the URL of the remote repository.\n\n<a id = \"4.3\"></a>\n### 4.3. Stage Changes\nTo stage changes for commit, use `git add <file_name>`. This command adds specified changes to the staging area. Replace `<file_name>` with the name of the file you want to stage or use `.` to stage all changes.\n\n<a id = \"4.4\"></a>\n### 4.4. Commit Changes\nTo commit staged changes with a meaningful message, use `git commit -m \"Your commit message here\"`. Replace `\"Your commit message here\"` with a concise and descriptive message.\n\n<a id = \"4.5\"></a>\n### 4.5. Check the Status of Repository\nTo check the current status of your git repository, use `git status`. This command shows information about untracked, modified or staged files.\n\n<a id = \"4.6\"></a>\n### 4.6. View Commit History\nTo view the commit history of your project, use `git log`. This command displays a chronological list of commits including commit messages, authors and timestamps.\n\n\n<a id = \"5\"></a>\n# 5. Branching and Merging\n\n<a id = \"5.1\"></a>\n### 5.1. Create a New Branch\nBranching allows to create isolated environments to work on specific features or fixes. To create a new branch:\n\n```bash\ngit branch new-feature   # Create a new branch\ngit checkout new-feature   # Switch to the new branch\n```\n\nThis sequence of commands creates a new branch named 'new-feature' and switches to it.\n\n<a id = \"5.2\"></a>\n### 5.2. Switch Between Branches\nSwitching between branches is essential when you need to work on different features or fixes. Use the `git checkout` command:\n\n```bash\ngit checkout main   # Switch to the main branch\n```\n\nThis command navigates back to the 'main' branch. Ensure to commit or stash changes before switching to avoid conflicts.\n\n<a id = \"5.3\"></a>\n### 5.3. Merge Branches\nMerging combines changes from different branches. To merge changes from a feature branch into the main branch:\n\n```bash\ngit checkout main   # Switch to the main branch\ngit merge new-feature    # Merge the new-feature branch\n```\n\n<a id = \"6\"></a>\n# 6. Collaborate on GitHub\n\n<a id = \"6.1\"></a>\n### 6.1. Fork a Repository\nForking a repository creates a personal copy on your github account. To fork a repository, click the 'Fork' button on the repository page.\n\n<a id = \"6.2\"></a>\n### 6.2. Make Changes and Create a Pull Request\nAfter forking, make changes in your forked repository:\n\n```bash\ngit clone <your-fork-url>   # Clone your fork\ngit checkout -b   # Create a new branch for your changes\n\n# Make and commit your changes\n\ngit push origin my-changes   # Push changes to your fork on GitHub\n```\n\nCreate a pull request to propose your changes to the original repository.\n\n<a id = \"6.3\"></a>\n### 6.3. Review and Merge Pull Requests\nCollaborators review pull requests. After reviewing, merge the changes by clicking 'Merge Pull Request'.\n\n<a id = \"6.4\"></a>\n### 6.4. Sync Your Fork with the Original Repository\n\n```bash\ngit remote add upstream <original-repo-url>   # Add the original repository as a remote\ngit fetch upstream   # Fetch upstream changes\ngit checkout main   # Switch to the main branch\ngit merge upstream/main   # Merge changes from upstream\ngit push origin main   # Push changes to your fork on GitHub\n```\n\nThese commands ensure your fork reflects the latest changes from the original repository.\n\n\n<a id = \"7\"></a>\n# 7. GitHub Issues and Projects\n\n<a id = \"7.1\"></a>\n### 7.1. Create Issues\nIssues are used to track tasks, enhancements and bugs. They serve as a centralized way to manage and discuss work on your project. \nTo create an issue:\n\n  - Go to your repository on GitHub.\n  - Click on the \"Issues\" tab.\n  - Click the \"New Issue\" button.\n  - Provide a title, description and assign labels or assignees.\n  - Click \"Submit new issue.\"\n\n<a id = \"7.2\"></a>\n### 7.2. Associate Issues with Commits\nLinking commits to specific issues helps in tracking changes and associating them with the relevant task or bug. To link an issue to a commit, use the keyword \"Closes\" or \"Fixes\" in the commit message followed by the issue number:\n\n  ```bash\n git commit -m \"Commit message. Closes #1\"\n  ```\n<a id = \"7.3\"></a>\n### 7.3. Use GitHub Projects for Task Management\nGitHub Projects provide a Kanban-style board for managing tasks and workflows. To use github projects:\n\n  - Go to your repository.\n  - Click on the \"Projects\" tab.\n  - Create a new project board.\n  - Add and manage tasks in different columns (e.g. To Do, In Progress, Done).\n\n\n<a id = \"8\"></a>\n# 8. Additional Resources\n\n<a id = \"8.1\"></a>\n### 8.1. GitHub Documentation\nRefer to the [official GitHub documentation](https://docs.github.com/en) for in-depth information.\n\n<a id = \"8.2\"></a>\n### 8.2. Git Documentation\nExplore the [Git documentation](https://git-scm.com/doc) to understand core concepts.\n\n<a id = \"8.3\"></a>\n### 8.3. GitHub Learning Lab\nEnroll in [GitHub Learning Lab](https://github.com/apps/github-learning-lab) for interactive, hands-on learning experiences.","metadata":{}}]}