Group handbook

Git & pull requests.

给新成员的第一份协作指南:理解版本管理,并独立完成一次分支、提交与 Pull Request。

什么是版本管理?

版本管理记录文件在不同时间的状态,使我们能看清谁改了什么、为什么改,也能让多人在互不覆盖工作的情况下并行协作。

Git
运行在本地电脑上的版本管理工具。它保存提交、分支和项目历史。
GitHub
托管 Git 仓库并支持讨论、审阅和合并工作的协作平台。
Commit
一次有明确目的的版本记录。它应当小、完整,并带有清楚的说明。
Branch
从主线分出的独立工作区。新任务应在新分支完成,不直接修改 main。

安装与第一次配置

从 Git 官方页面选择 Windows、macOS 或 Linux 的安装方式。安装后打开 Terminal、PowerShell 或 Git Bash,先确认 Git 可以运行。

从 Git 官网下载
git --version
git config --global user.name "Your Name"
git config --global user.email "your-email@example.com"
git config --global init.defaultBranch main
git config --list

完成第一次真实提交

练习任务只有一个:在小组成员数据中加入自己的资料。开始前,请准备 GitHub 账户,并确认已获得仓库协作者权限。

  1. 01

    下载仓库

    Clone 会在电脑上建立一份带完整版本历史的项目副本。

    git clone https://github.com/pinzek/pinzek.github.io.git
    cd pinzek.github.io
  2. 02

    建立自己的分支

    分支名使用简短的小写英文;把 your-name 替换成自己的名字。

    git switch -c intern/your-name
    git branch --show-current
  3. 03

    只修改要求的内容

    按成员资料格式修改 group-members.js,保存后先查看状态和差异。

    git status
    git diff
  4. 04

    提交这次改动

    只暂存相关文件。提交信息说明做了什么,不写 update、test 等模糊词。

    git add group-members.js
    git commit -m "Add Your Name to group page"
  5. 05

    推送分支

    这会把本地分支上传到 GitHub,但不会直接改变 main。

    git push -u origin intern/your-name

什么是 Pull Request?

Pull Request(PR)不是“下载请求”,而是一份把某个分支合并进主线的提案。它让团队在合并前查看差异、讨论原因、提出修改并确认结果。

推送后进入 GitHub,选择 base: maincompare: intern/your-name,再创建 Pull Request。标题应能独立说明改动。

推荐的 PR 描述

What changed
- Added my profile to the group page.

Checks
- [x] Name and links are correct.
- [x] The page opens locally.
- [x] Only relevant files were changed.

真正需要记住的命令

不必一次记住所有 Git 命令。先熟悉下面这组日常动作。

常用 Git 命令及用途
命令 用途
git status确认当前分支、已修改和已暂存的文件。
git diff提交前检查尚未暂存的具体改动。
git switch -c branch-name新建分支并切换过去。
git add file选择要放入下一次提交的文件。
git commit -m "message"保存一次有说明的版本记录。
git push -u origin branch-name第一次把当前分支推送到 GitHub。
git pull把远端当前分支的新提交同步到本地。
git log --oneline -5查看最近五次提交。
  • 每次操作前先运行 git status,确认自己在哪个分支。
  • 不要直接向 main 提交或推送。
  • 遇到冲突或 push 被拒绝时先停下,不要使用 --force
  • 未经指导不要使用 reset --hard,也不要删除 .git 文件夹。

如何带实习生完成这节课

用一次 45 分钟的现场练习代替长时间讲授。每个人都在自己的分支完成同一个小任务,并互相审阅 PR。

  1. 用本仓库的历史和一条真实 diff 解释版本管理。

  2. 完成安装、身份配置、clone,并确认所有人都能看到项目。

  3. 每人建立分支、添加个人资料、检查 diff、commit 并 push。

  4. 创建 PR,两人互审:核对资料、链接和改动范围。

  5. 根据意见修改,由维护者合并;全员观察 main 的变化。