diff --git a/README.md b/README.md index 9b42da1..b930c8c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,134 @@ -# handbook +# 团队 Git 使用手册(git.yami.ink 新手版) -团队 Git 使用手册 —— 新人必读 \ No newline at end of file +> 适用对象:第一次用 Git 的同学。**不用先去学 Git**,照着本文操作就行。 +> 遇到任何报错:**整屏复制报错,发给 AI(Trae / Claude / ChatGPT),照它说的做**。 + +--- + +## 〇、先记住三句话 + +1. 每天开工先 `git pull` +2. 改完代码 `git add .` → `git commit -m "说明"` → `git push` +3. 报错不可怕,复制给 AI 兜底 + +下面是详细步骤,第一次照着做一遍,之后就是肌肉记忆。 + +--- + +## 一、账号设置(登录后先做这两件事) + +- 平台地址:**https://git.yami.ink** (账号由管理员统一创建,无需注册) + +用管理员给你的用户名和初始密码登录后,点**右上角头像 → 「设置」**: + +### 1. 改密码 + +在左侧 **「账号」** 页最上方「修改密码」:填旧密码 → 设一个你记得住的新密码。 + +### 2. 改邮箱(自助,立即生效) + +同一页往下找 **「管理邮箱地址」**: + +1. 底部输入框填你的常用邮箱 → 点「添加」 +2. 不需要收验证邮件,**加完立即生效** +3. 把初始化的旧邮箱删掉(点邮箱旁的删除按钮) + +> 注意两点: +> - 这个邮箱要和你后面 `git config` 里填的邮箱**保持一致**(见第二节),这样你的提交在网页上才会显示你的头像和名字 +> - 这页最底下有「删除账号」红色按钮,**别乱点** + +### 3. 界面是英文?切中文 + +头像 → 设置 → **「外观」(Appearance)** → Language 选 **简体中文** → 保存。 + +### 4. 忘记密码怎么办 + +平台没配邮件服务,网页上「忘记密码」点不出结果,**直接找管理员重置**。 + +--- + +## 二、本地准备(每台电脑只做一次) + +### 1. 安装 Git + +下载:https://git-scm.com/download/win —— 安装时一路「Next」到底即可。 + +### 2. 告诉 Git 你是谁 + +打开 Trae / VSCode 的终端(或开始菜单里的「Git Bash」),粘贴运行(引号里换成自己的): + +```bash +git config --global user.name "你的名字(拼音或网名)" +git config --global user.email "你在第一节点设置的邮箱" +``` + +检验:运行 `git config --global --list`,能看到这两行就 OK。 + +--- + +## 三、第一次拿代码(clone) + +1. 在网页打开要协作的仓库,点绿色 **「代码」** 按钮,复制 HTTPS 地址,形如: + `https://git.yami.ink/组织名/仓库名.git` +2. 在电脑上选一个放代码的文件夹,在该文件夹打开终端,执行: + +```bash +git clone 刚才复制的地址 +``` + +3. 第一次会弹出登录框:输入 git.yami.ink 的**用户名和密码**,Windows 会记住,以后免输。 + +完成后文件夹里多出一个和仓库同名的目录,代码就在里面。 + +--- + +## 四、日常上传(每天就是这一套) + +> 节奏口诀:**开工先 pull,改完 add + commit,收工 push**。 + +```bash +cd 仓库文件夹 # 进入 clone 下来的代码目录 +git pull # ① 拉取别人的最新改动(每天开工第一步!) + +# ......正常写你的代码...... + +git add . # ② 把改动放入暂存区(. 表示全部文件) +git commit -m "一句话说明改了什么,例如:修复登录按钮不响应" # ③ 打包成一次提交 +git push # ④ 上传到 git.yami.ink +``` + +push 成功后,刷新网页仓库页面就能看到你的提交和名字。 + +**为什么开工要先 pull?** 别人可能在你没干活的时候推了新代码,先 pull 拿到最新版,再改才不会打架。 + +--- + +## 五、不装 Git 也能干的活(网页端) + +- **看代码**:仓库页直接点文件浏览 +- **只想下载看,不参与协作**:绿色「代码」按钮 → 「下载 ZIP」 +- **看谁改了什么**:仓库页「提交」标签页 = 全部历史记录 +- **改个小文件(文档类)**:进入文件 → 「编辑」→ 改完在底部填提交说明 → 「提交变更」 +- **报 bug / 提需求**:仓库页「议题(Issues)」→ 「创建议题」,标题写清现象,正文贴截图和复现步骤 + +--- + +## 六、常见报错对照表 + +| 报错关键词 | 意思 | 怎么办 | +|---|---|---| +| `Please tell me who you are` | 没做第二节的身份配置 | 回去做 `git config` 那两条命令 | +| `Authentication failed` | 用户名或密码错 | 确认输的是用户名(不是邮箱);密码改过就用新密码 | +| `! [rejected] ... fetch first` | 服务器上有你本地没有的提交 | 先 `git pull`,然后重新 push | +| `CONFLICT (content)` | 你和别人改了同一个地方 | 别慌,把整屏报错发给 AI,按它说的做 | +| `not a git repository` | 当前文件夹不是代码仓库目录 | `cd` 到 clone 下来的那个文件夹里 | +| `nothing to commit` | 没有改动可提交 | 检查文件是否保存、是否在正确目录 | + +--- + +## 七、三条纪律 + 万能兜底 + +1. **每天开工先 `git pull`** +2. **尽量各改各的文件**,避免多人同时改同一个文件 +3. **push 前先 `git pull`**;push 被拒就先 pull 再试 +4. 万能兜底:**整屏复制报错 + 说一句你刚才在干什么 → 发给 AI → 照做**。还搞不定,找管理员。