Advance Git Sheet For Open Source Contributors

Contributing to open-source projects is a fantastic way to enhance your coding skills, collaborate with a large community, and give back to the tech world. However, navigating Git can be challenging for many. This advanced Git cheat sheet aims to equip open-source contributors with essential commands and best practices to simplify their workflow, resolve conflicts, and manage complex version control tasks efficiently.

1. Configure Git Environment

To set up a git environment you have to first download it, you can download it from git official.

git config --global user.name "your git username"
git config --global user.email "githubemail.com"

Set Up Aliases for Frequent Commands

git config --global alias.co checkout
git config --global alias.br branch
git config --global alias.ci commit
git config --global alias.st status

after setting up your GitHub configurations is time to make open-source contributions!

2. Working with Branches

Efficient branch management is crucial for open source contributions.

Create a New Branch

git checkout -b new-branch-name

Switch to an Existing Branch

git checkout branch-name

List All Branches

git branch -a

Delete a Branch

git branch -d branch-name

3. Advanced Merging and Rebasing

Handling merges and rebases can help maintain a clean project history.

Merge a Branch

git checkout main
git merge feature-branch

Rebase Your Branch

git checkout feature-branch
git rebase main

Resolve Merge Conflicts

When conflicts occur, manually resolve them in the affected files and then:

git add resolved-file
git rebase --continue

4. Stashing Changes

Stashing is useful for temporarily shelving changes you aren’t ready to commit.

Stash Your Changes

git stash

Apply Stashed Changes

git stash apply

List Stashed Changes

git stash list

5. Cherry-Picking Commits

Cherry-picking allows you to apply specific commits from one branch to another.

Cherry-Pick a Commit

git checkout target-branch
git cherry-pick commit-hash

6. Working with Remotes

Managing remotes is essential for collaboration on open source projects.

Add a Remote Repository

git remote add origin https://github.com/user/repo

Fetch Changes from Remote

git fetch origin

Push Changes to Remote

git push origin branch-name

7. Git Hooks

Git hooks automate tasks and enhance your workflow.

Create a Pre-Commit Hook

Navigate to your Git hooks directory and create a pre-commit file:

#!/bin/sh
# Pre-commit hook script

Make the Hook Executable

chmod +x .git/hooks/pre-commit

8. Git for Open Source Contributors

To get starting with first opensource contributions first you have to find a project to contribute to. There are various open-source beginner-friendly projects available search for them and get settled with any one of them. Follow the below steps to make your first open source contribution.

Step 1: Fork the project from the right corner icon. We fork project for making it available on our local machine and we can test and add new features to it.

Step 2: Clone the project to your local machine. The cloning project is simple and it set up the project on our local machine.

Step 3: Set up upstream for the project. Upstream helps you to keep track of the difference between the clone project and the original repository. Open a pull request.

Step 4: Create the branch for an open-source project to contribute. Creating a branch is like working on the idea we want to implement or the bug we want to solve for the project.

git checkout -b <your branch name>

Step 5: Commit contributions

Committing your contributions is important and easy. It keeps track of your contributions and code which you add to the branch and while making a commit try to give a specific message because next time you can directly work on previous code as well.

git add .
git commit -m 'Commit message'

Step 6: Pull from upstream to the branch.

git pull upstream <branch name>

Step 7: Push on your working branch.

git push origin <branch-name>

Step 8: Open a pull request. After adding changes to the project create a pull request to compare with the original repository.

After creating your first pull request successfully the next step is to explain the changes you did, The dialogue box will open and you have to explain specific details about the changes.