GitHub 基础入门教程

📚 本课程介绍了 GitHub 的基础知识,包括托管和管理代码的版本控制平台。

GitHub 入门

手绘笔记由 Tomomi Imura 提供


✅ 课前测验

课前测验


🚀 本课涵盖内容:

  • 在本地机器上跟踪代码版本
  • 与他人协作开发项目
  • 如何为开源项目贡献代码

⚙️ 前置条件:

  1. 检查 Git 是否安装
    在终端运行:

    1. git --version

    如果 Git 未安装,下载 Git

  2. 配置 Git 个人信息

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

    检查当前配置:

    1. git config --list
  3. 环境准备

    • GitHub 账号
    • 代码编辑器(如 VS Code)
    • 打开终端或命令行工具
    • 登录 GitHub 并创建账户

✅ GitHub 是最知名的代码托管平台,但不是唯一的选择。


🛠️ 代码管理

你可以使用 Git 管理项目的版本历史,这就像是给未来的自己写信,帮助回顾当时的开发决策。


🔥 创建 Git 仓库并提交代码

视频教程

  1. 在 GitHub 上创建仓库

    • 登录 GitHub,点击右上角的 New Repository 按钮
    • 填写仓库名称,点击 Create Repository
  2. 在本地创建 Git 仓库

    • 打开终端,切换到项目目录:
      1. cd 项目目录
    • 初始化 Git 仓库:
      1. git init
  3. 检查仓库状态

    1. git status
  4. 添加所有文件到暂存区

    1. git add .
  5. 添加指定文件到暂存区

    1. git add 文件名
  6. 取消暂存

    • 取消所有文件:
      1. git reset
    • 取消指定文件:
      1. git reset 文件名
  7. 提交代码

    1. git commit -m "首次提交"
  8. 连接 GitHub 仓库

    • 在 GitHub 上复制仓库地址
    • 在终端运行:
      1. git remote add origin https://github.com/你的用户名/仓库名.git
  9. 推送代码到远程仓库

    1. git push -u origin main
  10. 后续提交

    • 持续更新代码:
      1. git add .
      2. git commit -m "你的提交信息"
      3. git push

✅ 使用 .gitignore 文件忽略不需要提交的文件,例如环境变量或本地配置文件。


💡 提交信息规范

  • 提交信息应使用 祈使句,如:
    • fix: 修复登录 bug
    • feat: 新增用户搜索功能
  • 不要使用过去式或第三人称:
    • fixed bug
    • added feature
  • 提交信息格式:

    1. <type>: <subject>
    2. <body>(可选)

    常见类型:

    • feat: 新功能
    • fix: 修复 bug
    • docs: 文档更新
    • style: 格式调整(不影响代码逻辑)
    • refactor: 重构代码
    • test: 测试代码

✅ 编写清晰的提交信息有助于回溯和协作。


👥 与他人协作

视频教程

  1. 创建分支

    1. git branch 分支名
  2. 切换分支

    1. git switch 分支名
  3. 合并主分支最新代码

    1. git switch main
    2. git pull
  4. 合并分支

    1. git switch 分支名
    2. git merge main
  5. 推送到远程仓库

    1. git push --set-upstream origin 分支名
  6. 创建 PR(合并请求)

    • 打开 GitHub 仓库
    • 点击 Pull Request 并填写说明
    • 提交合并请求

✅ 合并 PR 后清理本地分支:

  1. git branch -d 分支名

🌟 开源贡献指南

  1. 在 GitHub 搜索带有 good-first-issue 标签的开源项目
  2. Fork 仓库并克隆到本地:
    1. git clone 仓库地址
  3. 新建分支并进行开发:
    1. git checkout -b feature-branch
  4. 提交代码并推送:
    1. git add .
    2. git commit -m "feat: 添加新功能"
    3. git push origin feature-branch
  5. 提交 PR

📌 GitHub 常用功能

  • Star:收藏感兴趣的项目
  • Fork:复制项目到自己的账户
  • Issues:跟踪和讨论项目问题
  • Pull Request:合并请求,协作开发
  • Codespaces:GitHub 在线开发环境

✅ 尝试在 GitHub 上探索设置、项目和看板功能。


🎯 挑战任务

  • 与朋友协作开发,练习 Fork、分支管理和合并代码。

✅ 课后测验

课后测验


📚 自学与复习

✅ 多多练习,掌握 Git 与 GitHub 的版本控制与协作开发! 🚀