Skip to content

GitHub.md

Latest commit

 

History

History
140 lines (91 loc) · 4.66 KB

GitHub.md

File metadata and controls

140 lines (91 loc) · 4.66 KB

Starting

Initiate Git Repository

Create a folder on local drive where all of your working source files will be placed (e.g., Source). This will initialize the current folder as a Git repository.

git init

Configure User Profile

git config --global user.name '<Your Name>' & git config --global user.email '<your_email>@gmail.com'

This creates a .gitconfig file with the following contents:

[user]
    name = <Your Name>
    email = <your_email>@gmail.com

Fetch Repo

git clone https://<username>:<personal-access-token>@github.com/<organization>/<respository-name>.git

Authentication Issues

Make sure you have a secret store for the credentials.

Arch Linux:

sudo pacman -S gnome-keyring
systemctl --user enable --now gnome-keyring-daemon.service
code --password-store="gnome-libsecret"

Windows WSL2

# 1. Ensure Git for Windows is installed on your Windows host.

# 2. Configure Git in WSL to use the Windows Git Credential Manager:
git config --global credential.helper "/mnt/c/Program\ Files/Git/mingw64/bin/git-credential-manager.exe"

# 3. Ensure GCM is configured to use Windows as the credential store (usually default):
git config --global credential.credentialStore windows

Visual Studio Code Terminal

If general Git solutions for authentication issues don't work, specific VS Code settings might be interfering:

  • Disable Terminal Authentication: This forces Git operations in the integrated terminal to use the system's authentication methods rather than VS Code's internal handler.
  • Go to File > Preferences > Settings (or Code > Settings on some Linux builds).
  • Search for git.terminalAuthentication and uncheck the box.

Check Default Browser Settings:

  • Sometimes, the authentication process which relies on opening a browser window might fail if the default system browser is misconfigured or a Flatpak installation.
  • Ensure a standard browser (like Chrome or Firefox installed via system packages, not Flatpak) is set as the default in your Linux system settings.

Alternatively, you can try signing in via the GitHub CLI using the command gh auth login in the VS Code terminal. Clear Cached Credentials: If an old, invalid password is being used repeatedly, clear any saved credentials from your system's keyring or a credential manager. The method varies depending on your Linux distribution and desktop environment (e.g., Gnome Keyring).

Add Files

git add index.html // Adds a specific file to the staging area.
git add *.html     // Adds *.html files to the staging area.
git add .          // Adds the entire current directory to the staging area.

Remove Files

git rm –cached index.html

Review Pending Changes

See tracked files to be committed.

git status

Commit

This command opens a Vi editor in terminal mode. You have to uncomment the "Initial commit" text, save, and quit Vi to commit.

git commit  // Uncomment "Initial commit" and write/quit (wq) file.

This command is a faster way by adding an option with commit comments.

git commit –m "<your comment>"

Branches

Querying

See Local Branches

git branch

See Remove Branches

git branch -r

See All Local and Remove Branches

git branch -a

Update Available Branches to Local

git fetch -all

Managing

Create New Branch

git branch <branch-name>

Switch Branch

git checkout <branch-name>

Create and Switch Branch

git checkout -b <branch-name>

Rename Local Branch

git branch -m <new-branch-name>

Merge with Master

git merge <branch-name>

Sync to Master

git push -u origin master

Sync to Local

git pull

Projects, Issues, and Milestones

Projects

GitHub Projects (the planning tool) can live at different levels depending on what you're trying to organize:

  • Repository-level Projects: These are contained within a specific repository. They are best for managing tasks, bugs, and features that only apply to that one codebase.
  • User/Account-level Projects: These live on your personal profile. They are perfect for "big picture" planning that spans across multiple repositories you own.
  • Organization-level Projects: If you are part of a team, projects can live at the organization level. This allows you to track issues and pull requests from many different repositories owned by that organization in one central board.

Issues

GitHub Issues live within the a repository****. The Project is just a view that pulls in issues from one or more repositories to help visualize the scope of a Project.

  • Note that Draft issues only live in the Project until it is converted into an Issue.

Milestones

GitHub Milestones live strictly inside a Repository, just like Issues.