In the fast-paced world of software development, version control is a cornerstone of efficient collaboration. At [Your Company Name], we use Git and GitHub extensively to manage code and streamline teamwork. This guide provides an overview of these essential tools, ensuring you hit the ground running.

Introduction to Git and GitHub

What is Git?

Git is a version control system that tracks changes in your codebase, allowing multiple developers to collaborate efficiently. It enables you to:

• Keep a history of changes.
• Roll back to previous versions if needed.
• Work on different features simultaneously using branches.

What is GitHub?

GitHub is a cloud-based platform for hosting Git repositories. It provides tools for:

• Collaborative coding.
• Code reviews and pull requests.
• Issue tracking and project management.

Setting Up Git

Step 1: Install Git

• Download Git for your operating system.

Step 2: Configure Git

Run these commands to set your name and email (used for commits):

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

Step 3: Verify Configuration

git config --list

Cloning a Repository

To start working on a project, clone the repository to your local machine:

git clone https://github.com/your-company/repository-name.git

Replace repository-name with the actual repository URL.

Basic Git Commands

1. Check Repository Status

git status

2. Add Changes to Staging Area

git add <file-name>  # Add a specific file
git add .             # Add all changes

3. Commit Changes

git commit -m "Brief message describing the change"

4. View Commit History

git log

5. Push Changes to Remote Repository

git push origin <branch-name>

6. Pull Latest Changes

git pull origin <branch-name>

Branching and Merging

Step 1: Create a New Branch

git checkout -b feature/branch-name

Step 2: Switch to an Existing Branch

git checkout branch-name

Step 3: Merge Branches

First, switch to the branch you want to merge into (e.g., main):

git checkout main
git merge feature/branch-name

Working with Remote Repositories

Adding a Remote

git remote add origin https://github.com/your-company/repository-name.git

Viewing Remotes

git remote -v

Removing a Remote

git remote remove origin

Resolving Merge Conflicts

1. Identify the files with conflicts using git status.
2. Open the conflicting files and resolve the conflicts.
3. Mark the conflicts as resolved:

   git add <file-name>

1. Commit the resolved changes:

   git commit -m "Resolved merge conflicts"

Writing Effective Commit Messages

• Format: Use the format [Type]: Description.
• Types:
  • feat: New feature
  • fix: Bug fix
  • docs: Documentation update
  • style: Code style changes
  • refactor: Code restructuring
  • test: Adding or updating tests

Example:

feat: add user authentication module

Best Practices for Git and GitHub

1. Branch Naming: Use descriptive names like feature/login-page or bugfix/header-issue.
2. Small Commits: Commit small, logical changes frequently.
3. Pull Before Push: Always pull the latest changes before pushing your work.
4. Code Reviews: Create pull requests and request reviews before merging to main.
5. Backup Work: Push your work regularly to avoid data loss.

Additional Resources

• Git Official Documentation
• GitHub Learning Lab
• Pro Git Book

Using Git and GitHub effectively is key to our success at [Your Company Name]. If you have any questions, don't hesitate to reach out to your mentor or team lead. Welcome aboard, and happy coding!