Skip to content

step3_config_git.md

Latest commit

 

History

History
188 lines (134 loc) · 6.33 KB

step3_config_git.md

File metadata and controls

188 lines (134 loc) · 6.33 KB

Configuring Git/GitHub in VS Code 😸

Optional, but useful!

Step 1: Download and Install Git

  1. Open Terminal and run: git --version
  2. If it returns something like git version 2.37.1 then you're good!
  3. If not, install Git for Mac and restart VS Code

Step 2: Initialize Git in your project folder

  1. In the Terminal inside VS Code (or regular Terminal if you're in the project folder), run:

    git init

    This creates a .git folder, which means your local Git repository is now active!

Step 3: Create a .gitignore File (if you haven't already)

  1. Create a .gitignore file in your project and add:

    # Ignore Python virtual environment
my-venv-name/

# Ignore VS Code settings
.vscode/

# Byte-compiled / cache files
__pycache__/
*.pyc

# Ignore system files
.DS_Store

    This file tells GitHub what to ignore in your Project folder when commiting messages, perfoming merges, push/pull commands, etc. If you don't do this, you'll likely have thousands of commits that can overload these commands!

Step 4: Stage and Commit your files

  1. In Terminal, run the following:

    git add .
git commit -m "Initial commit"

Step 5: Use VS Code's Git Interface

  1. Now that Git is initialized, you'll see source control options in the VS Code sidebar:
    • Click the Source Control icon* (third icon from the top or ⌃⇧G)
    • You'll see your project files listed as changes
    • Type a message in the box (e.g., "Initial commit") and hit the checkmark ✔️ to commit

Note 🏁: If you have to restart VS Code, reset your venv too

  1. Navigate to your project folder
  2. Run the following: source my-venv-name/bin/activate

Step 6: Connect to GitHub Repository (Optional, Recommended)

Option 6.1: If you already have an empty GitHub repo:

  1. In Terminal, run the following:

    git remote add origin https://github.com/you-username/your-repo-name.git
git branch -M main
git push -u origin main

You may be prompted to log into GitHub via your browser or VS Code. Do it... or else...

*Note: *Also, GitHub has required multifactor authetication. You may need to access GitHub first through SSH (secure shell protocol). Steps to do this are found here.

Option 6.2: If you have an established and populated GitHub repo:

  1. If you have a project folder, but it's not yet connected to GitHub do:

    In Terminal, in VS Code, run the following:

    git remote add origin htts://github.com/you-username/your-repo-name.git
git pull origin main

    Make sure your local branch tracks the remote branch:

    git branch --set-upstream-to=origin/main main

  2. If you haven't set up the folder (AKA cloned the repository) do:

    In Terminal, in VS Code, navigate to where you want the folder to go.

    cd path/to/your/desired/folder

    Clone your GitHub repo:

      git clone https://github.com/your-username/your-repo-name.git

    Open the folder in VS Code:

    cd your-repo-name

    Make sure your local branch tracks the remote branch:

    git branch --set-upstream-to=origin/main main

Option 6.3: If you need to create a GitHub repo:

  1. Look it up, nerd (said lovingly). It's decently straigtforward: Go to GitHub
  2. 📝 Github began asking for a two-factor authentication, so you may need to link your GitHub with SSH instead of HTTPS if you have never used GitHub before. The steps for setting this up are found here - Generating a new SSH key
  3. See Option 6.1

Step 7: Configure Git Username and Email

  1. Run these two commands (replacing the info with your own):

    git config --global user.name "Firstname Lastname"

    git config --global user.email "your-email@example.com"

  2. ⚠️Note: Use the email associated with your GitHub account so GitHub links your commits to your profile

    For example, if your GitHub email is myemail@mail.com, run:

    git config --global user.name "myemail@mail.com"

Step 8: Re-run the commit command

  1. In Terminal in your project folder, in the virtual environment, run:

    git commit -m "Merging remote origin/main with local project"

  2. Then push everything from your local device (your computer) to your GitHub repo on the web:

    git push

  3. If you want, you can pull everything from the web to your computer, just to be super certain everything is matching up:

    git pull

✅ Done!

You now have installed git for version control of your code, and have your own repository up and running with:

  • git in VS Code
  • VS Code synced with your external GitHub repository
  • a .gitignore file that ensures the correct files get synced

VS Code Git Tips

  • You can see changes by clicking on each file in the Source Control panel
  • Use "..." > View > Commit History to see Git history
  • Press ⌘ShiftP and type Git: to see all available Git commands

😩 "Divergent Branches" Error

If you need to reconcile divergent branches, you can do the following:

  1. In terminal, run:

    git status

    If you get the message "Your branch and 'origin/main' have diverged, ...", then you probably did a local commit before pulling the GitHub repo.

Option 1: If you don't care about local changes and want to match your GitHub repo:

  1. If you are willing to lose your local commits (changes, notes to self) then run:

    git fetch origin
git reset --hard origin/main

Option 2: If you want to merge your local changes with remote changes (safest bet).

  1. Run this to merge everything, and do a pull request:

    git config pull.rebase false
git pull

  2. If you want to set your git to merge discrepancies automatically in the future, run:

    git config --global pull.rebase false

Option 3: If you want a linear history of commits (rebase instead of merge).

  1. If you want your local commits to be on top of the remote commits (cleaner history) then run:

    git config pull.rebase true
git pull