Git Documentation
Step-by-Step Guide to Using Git
1. Setting Up Git
Install Git:
Download and install Git from git-scm.com.
Configure Git:
Set your username and email address for Git.
git config --global user.name "Your Name"
git config --global user.email "[email protected]"
2. Creating a Repository
Initialize a New Repository:
Navigate to your project directory and initialize a Git repository.
cd path/to/your/project
git init
Clone an Existing Repository:
If you want to work on an existing project, you can clone a repository.
3. Working with Files
Check Repository Status:
See the status of your working directory.
git status
Add Files to Staging Area:
Add specific files or all changes to the staging area.
git add <file> # Add a specific file
git add . # Add all changes
Commit Changes:
Commit the staged changes with a descriptive message.
git commit -m "Your commit message"
4. Branching and Merging
Create a New Branch:
Create and switch to a new branch.
git branch new-branch
git checkout new-branch
Or create and switch in one command:
git checkout -b new-branch
List Branches:
List all branches in the repository.
git branch
Merge a Branch:
Switch to the branch you want to merge into (e.g., main), then merge the changes from another branch (e.g., new-branch).
git checkout main
git merge new-branch
Resolve Conflicts:
If there are conflicts, Git will prompt you to resolve them. Edit the conflicting files, add them to the staging area, and commit the merge.
# Edit conflicting files
git add <resolved-file>
git commit -m "Resolve merge conflicts"
Delete a Branch:
After merging, you can delete the branch.
git branch -d new-branch
领英推荐
5. Remote Repositories
Add a Remote Repository:
Add a remote repository to push your changes.
git remote add origin https://github.com/username/repository.git
Push Changes:
Push your changes to the remote repository.
git push origin branch-name
Fetch Changes:
Fetch changes from the remote repository.
git fetch origin
Pull Changes:
Fetch and merge changes from the remote repository.
git pull origin branch-name
6. Advanced Git Commands
Revert a Commit:
Revert a specific commit.
git revert <commit-hash>
Reset to a Previous Commit:
Reset your repository to a previous state.
git reset --hard <commit-hash>
Stash Changes:
Save changes for later without committing.
git stash
git stash pop # Apply stashed changes
View Commit History:
View the commit history of your repository.
git log
7. Collaboration Workflow
Fork the Repository:
On GitHub, click the "Fork" button on the repository page to create a personal copy of the repository.
Clone the Forked Repository:
Clone the repository to your local machine.
cd forked-repository
Create a Feature Branch:
Create a new branch for your feature or bug fix.
git checkout -b feature-branch
Make Changes and Commit:
Make your changes, add them to the staging area, and commit them.
git add .
git commit -m "Add new feature"
Push Your Changes:
Push your changes to your forked repository.
git push origin feature-branch
Create a Pull Request:
On GitHub, navigate to your forked repository and click the "New pull request" button.
Select the branch you want to merge into (e.g., main) and the branch you made changes on (feature-branch), then create the pull request.
By following these steps, you can effectively manage your project using Git and GitHub, collaborate with others, and keep your project organized.