Git 使用入门指南

Git 使用入门指南

Git 是一个强大的分布式版本控制系统,能够帮助你跟踪代码更改并进行协作开发。

  1. Git 基础配置

    首次使用 Git,需要配置你的用户名和邮箱:

    git config --global user.name "你的名字"
    git config --global user.email "你的邮箱"
    

    配置完成后,可以用以下命令查看配置信息:

    git config --list
    
  2. 初始化 Git 仓库

    进入你的项目根目录,初始化一个 Git 仓库:

    cd /path/to/your/project
    git init
    
  3. 添加文件到暂存区

    添加所有修改或新增的文件:

    git add .
    

    添加指定文件:

    git add your_file.txt
    
  4. 提交文件

    将暂存区的文件提交到本地仓库,并添加提交信息:

    git commit -m "你的提交信息,例如:Initial commit for project setup"
    
  5. 查看仓库状态

    查看当前工作区、暂存区和本地仓库的状态:

    git status
    
  6. 查看提交历史

    查看详细提交日志:

    git log
    

    查看简短提交日志:

    git log --oneline
    
  7. 关联远程仓库

    将本地仓库关联到 GitHub 上的远程仓库(请替换为你的实际仓库地址):

    git remote add origin https://github.com/你的用户名/你的仓库名.git
    
  8. 推送到远程仓库

    将本地的 main 分支推送到远程仓库:

    git push -u origin main
    

    -u 参数表示将本地的 main 分支和远程的 main 分支关联起来,以后只需执行 git push 即可。

  9. 从远程仓库拉取更新

    在团队协作时,拉取远程仓库的最新代码:

    git pull origin main
    
  10. 分支管理

    创建新分支:

    git branch new-feature
    

    切换分支:

    git checkout new-feature
    

    创建并切换分支:

    git checkout -b new-feature
    

    合并分支(先切换到目标分支,例如 main,再合并):

    git checkout main
    git merge new-feature
    

    删除分支:

    git branch -d new-feature  # 正常删除
    git branch -D new-feature  # 强制删除
    

.gitignore 文件使用指南

.gitignore 文件用于告诉 Git 哪些文件或目录不需要被版本控制,常用于忽略日志文件、编译生成文件、依赖包、个人配置等。

  1. 创建 .gitignore 文件

    在项目根目录下创建 .gitignore 文件:

    touch .gitignore
    
  2. .gitignore 文件内容示例

    # Git Generated Files
    .git/
    
    # Docker related files
    docker-compose.override.yml  # 覆盖文件,可能包含敏感信息
    .dockerignore
    !docker-compose.yml          # 确保 docker-compose.yml 被跟踪
    
    # Synapse and PostgreSQL Data
    data/       # Synapse 数据目录
    pgdata/     # PostgreSQL 数据目录
    logs/       # 日志文件
    temp/       # 临时文件
    
    # Python specific (如果项目包含 Python 代码)
    *.pyc
    __pycache__/
    .env        # 环境变量文件,可能包含敏感信息
    venv/       # 虚拟环境
    
    # Node.js specific (如果项目包含 Node.js/Element 构建过程)
    node_modules/
    npm-debug.log*
    yarn-debug.log*
    
    # 操作系统生成的文件
    .DS_Store   # macOS
    Thumbs.db   # Windows
    
  3. .gitignore 规则说明

    • 空行:被忽略
    • # 开头:注释
    • / 结尾:表示目录
    • ! 开头:表示不忽略(即使之前规则忽略了它)
    • *:通配符,匹配任意字符
    • ?:匹配单个字符
    • [abc]:匹配括号中的任意一个字符
  4. 使用 .gitignore 的最佳实践

    • 尽早创建:项目开始时就创建 .gitignore 文件
    • 提交到仓库:.gitignore 文件应提交到 Git 仓库,方便团队共享忽略规则
    • 生成工具:可使用在线工具生成适合项目的 .gitignore,例如 Toptal Gitignore Generator

以上内容涵盖了 Git 的基本配置、仓库初始化、文件管理、分支管理以及 .gitignore 文件的使用,适合个人开发者快速上手 Git 版本控制。希望对你有帮助!