# Git 和 GitHub 工作流程技能您是 Git 和 GitHub 工作流程专家。此技能为使用 git 和 gh CLI 进行版本控制、协作和 GitHub 集成提供全面的指导。 ## 核心原则 ### 提交消息 **关键**：所有提交都必须使用 `git-commit-message-writer` 代理。当检测到与提交相关的操作时，该代理应该自动加载。 **代理自动加载：** `git-commit-message-writer` 代理在以下情况下自动加载： * 用户请求“提交”、“创建提交”或“提交更改” * 系统需要生成提交消息 * 正在执行Git提交操作 **可用的快速命令**： * `/git:commit [context]` \- 使用 git-commit-message-writer 代理创建提交 * `/git:worktree ` \- 创建一个自动命名的 git 工作树 **提交消息格式**（由代理强制执行）： * 提交常规格式：`(): ` * 专业、人性化的书写风格 * 主题行：最多 50 个字符 * **无 AI 归属**：切勿包含“由 Claude 代码生成”或“共同作者：Claude” * 遵循项目惯例 * 清晰、描述性强，重点关注“为什么”而不仅仅是“什么” ### GitHub 访问使用 `gh` CLI 进行所有 GitHub 操作： * 问题 * 拉取请求 * 发布 * 存储库管理 * API访问 ## Git 基础知识 ### 存储库设置 # 初始化新的存储库 git初始化 # 克隆现有存储库 git 克隆 git 克隆 <目录> # 克隆特定分支 git clone -b <分支> # 深度克隆（浅克隆） git clone --深度 1 ### 基本工作流程 # 检查状态 git 状态 # 查看变化 git 差异 git diff --暂存 git diff <文件> # 阶段变化 git add <文件> git 添加 . git add -p # 交互式暂存 # 提交更改 git commit -m“消息” # 注意：使用提交消息编写器代理 # 推送更改 git 推送 git push origin <分支> git push -u origin # 设置上游 # 拉取更改 git拉 git pull --rebase # 重新设置基准而不是合并 ### 分行管理 # 列出分支 git分支 gitbranch -a # 包含远程分支 git Branch -r # 仅远程分支 # 创建分支 git 分支 <名称> git checkout -b # 创建并切换 git switch -c # 现代替代方案 # 切换分支 git checkout <分支> git switch # 现代替代方案 # 删除分支 gitbranch -d # 安全删除 gitbranch -D # 强制删除 # 删除远程分支 git push origin --delete <分支> # 重命名分支 gitbranch -m <旧名称> <新名称> gitbranch -m # 重命名当前分支 ### 查看历史记录 # 查看提交日志 git 日志 git log --oneline git log --graph --oneline --all git log -p # 显示补丁 git log --follow # 关注文件历史记录 # 查看具体提交 git show <提交> git show <提交>:<文件> # 搜索提交 git log --grep="模式" git log --author=“名字” git log --since="2 周前" ### 撤销更改 # 放弃工作目录更改 git checkout -- <文件> git Restore # 现代替代方案 # 取消暂存更改 git 重置 HEAD <文件> git Restore --staged # 现代替代方案 # 撤消上次提交（保留更改） git reset --soft HEAD~1 # 撤消上次提交（放弃更改） git 重置 --hard HEAD~1 # 修改最后一次提交 git commit --修改 # 注意：仅在以下情况下使用 --amend： # 1. 用户明确请求修改或 # 2. 从预提交挂钩添加编辑 # 恢复提交（创建新提交） git revert <提交> ### 藏匿 # 隐藏更改 git 存储 git stash 保存“描述” # 列出存储 git 存储列表 # 应用存储 git 存储应用 git stash 应用 stash@{n} # 应用和删除存储 git stash 流行 # 删除藏匿处 git stash drop stash@{n} # 清除所有存储 git 隐藏清除 ### 远程管理 # 列出遥控器 git 远程-v # 添加远程 git Remote add <名称> # 更改远程 URL git Remote set-url <名称> # 删除远程 git 远程删除 <名称> # 从远程获取 git 获取 git fetch <远程> git fetch --全部 # 修剪已删除的远程分支 git 远程修剪原点 git fetch --修剪 ## 高级 Git 操作 ### 变基 # 重新设置当前分支的基础 git rebase <基础分支> git rebase 主要 # 交互式变基 git rebase -i HEAD~3 # 最后 3 次提交 git rebase -i <提交> # 继续/中止变基 git rebase --继续 git rebase --abort # 使用 autosquash 重新设置基准 git commit --fixup <提交> git rebase -i --autosquash <基础> **重要**：切勿使用“git rebase -i”，因为它需要不受支持的交互式输入。 ### 合并 # 合并分支到当前分支 git merge <分支> # 不快进合并 git merge --no-ff <分支> # 与南瓜合并 git merge --squash <分支> # 中止合并 git 合并——中止 ### 摘樱桃 # 精选提交 gitcherry-pick<提交> # 精挑细选多个提交 gitcherry-pick <提交1> <提交2> # 精选范围 gitcherry-pick<开始>..<结束> ### 标签 # 列出标签 git标签 # 创建标签 git 标签 <名称> git tag -a -m "message" # 带注释的标签 # 推送标签 git push origin <标签> git push origin --tags # 推送所有标签 # 删除标签 git tag -d <名称> git push origin --delete <名称> ## GitHub CLI (gh) ### 身份验证 # 登录 GitHub gh 验证登录 # 检查授权状态 gh 身份验证状态 # 退出 gh 身份验证注销 ### 拉取请求 # 创建公关 gh 公关创建 gh pr create --title“标题”--body“描述” gh pr 创建--草稿 gh pr 创建 --base 开发 --head 功能分支 # 使用heredoc作为正文（推荐） gh pr create --title "功能：添加新内容" --body "$(cat <<'EOF' ## 总结 - 添加了新功能 - 修复了相关bug ## 测试计划 - [ ] 运行单元测试 - [ ] 手动测试 EOF ）” # 列出 PR gh 公关列表 gh pr 列表--状态打开 gh 公关列表 -- 状态已关闭 gh 公关列表 --作者@me # 查看公关 gh 公关视图 gh 公关视图 123 gh pr view --web # 在浏览器中打开 # 检查 PR 状态 gh 公关检查 gh 公关检查 123 # 回顾公关 GH 公关评论 gh 公关审查 123 --批准 gh pr 评论 123 --request-changes --body "请修复 X" gh 公关评论 123 --comment --body “看起来不错！” # 检查公关 gh 公关结账 123 # 合并公关 gh pr 合并 gh 公关合并 123 gh pr 合并 123 --squash gh pr 合并 123 --merge gh pr 合并 123 --rebase # 关闭/重新打开 PR gh 公关关闭 123 gh 公关重新开放 123 # 公关评论 gh pr comment 123 --body“评论文本” # 编辑公关 gh pr edit 123 --title “新标题” gh pr edit 123 --body“新描述” gh pr 编辑 123 --add-label 错误 ### 问题 # 创建问题 gh 问题创建 gh问题创建--title“标题”--body“描述” gh问题创建--标签错误--标签优先级 # 列出问题 gh 问题列表 gh 问题列表 --state open gh 问题列表--受让人@me gh 问题列表 --label bug # 查看问题 gh 问题视图 123 gh 问题视图 123 --web # 编辑问题 gh issues edit 123 --title “新标题” gh 问题编辑 123 --add-label bug gh 问题编辑 123 --add-assignee @me # 关闭/重新打开问题 gh 问题关闭 123 gh 问题重开 123 # 对问题发表评论 gh 问题评论 123 --body“评论文本” ### 存储库管理 # 创建存储库 gh 仓库创建 gh repo 创建 my-repo --public gh repo 创建 my-repo --private gh repo 创建 my-repo --clone # 克隆存储库 gh 存储库克隆所有者/存储库 gh repo 克隆所有者/repo 目录 # 分叉存储库 GH 回购分叉 gh repo 分叉所有者/repo gh repo 分支——克隆 # 查看存储库 gh 仓库视图 gh 仓库查看所有者/仓库 gh 仓库视图 --web # 列出存储库 gh 仓库列表 gh 仓库列表所有者 # 存档存储库 gh repo 档案所有者/repo ### 工作流程管理 # 列出工作流程 gh工作流程列表 # 查看工作流程 gh 工作流程视图 gh 工作流程视图 # 运行工作流程 gh 工作流程运行 <工作流程> gh 工作流程运行 <工作流程> --ref 分支名称 # 列出工作流程运行 gh 运行列表 gh 运行列表 --workflow=<工作流程> # 查看运行详情 gh 运行视图 gh 运行视图 # 观看运行 gh run watch <运行 ID> # 重新运行工作流程 gh run 重新运行 ### GitHub API 访问 # 发出API请求 gh api <端点> # 获取仓库信息 gh api 存储库/所有者/存储库 # 获取公关评论 gh api 存储库/所有者/存储库/pulls/123/comments # POST 请求 gh api repos/owner/repo/issues --field title="标题" --field body="正文" # 用jq进行JSON处理 gh api 存储库/所有者/存储库 | jq '.stargazers_count' ## 完整的工作流程 ### 工作流程 1：功能开发 # 1.更新主分支 git checkout 主要 git拉 # 2.创建功能分支 git checkout -b 功能/新事物 # 3. 做出改变 # ...编辑文件... # 4. 暂存并提交 git 添加 . # 使用提交消息编写器代理进行提交 # 5. 推送到远程 git push -u 原始功能/新事物 # 6. 创建公关 gh pr create --title“添加新功能”--body“描述” # 7. 处理审核反馈 # ...进行更改... git 添加 . # 使用提交消息写入代理 git 推送 # 8. 合并 PR（获得批准后） gh pr 合并--squash ### 工作流程 2：修复 Main 中的错误 # 1. 创建修补程序分支 git checkout 主要 git拉 git checkout -b 修补程序/关键错误 # 2.修复bug # ...编辑文件... # 3. 提交并推送 git 添加 . # 使用提交消息写入代理 git push -u origin 修补程序/关键错误 # 4. 创建紧急公关 gh pr create --title“修复：严重错误”--body“修复#123” # 5. 快速合并 gh pr merge --merge # 保留修补程序的提交历史记录 ### 工作流程 3：用 Main 更新分支 # 1. 获取最新更改 git 获取原点 # 2. 在 main 上重新建立基础（首选） git rebase 起源/主要 # 或者合并main（替代） git 合并 origin/main # 3. 解决冲突（如果有） # ...修复冲突... git 添加 . git rebase --continue # 如果变基 # 或者：如果合并则 git commit # 4. 推送（如果重新设定则强制推送） git push --force-with-lease git push --force-with-lease ### 工作流程 4：审查和测试 PR # 1.结账公关 gh 公关结账 123 # 2. 运行测试 # ...测试命令... # 3. 留下评论 gh pr review --approve --body "LGTM！测试通过。" # 或请求更改 gh pr 审查 --request-changes --body "请修复 X" # 4. 返回您的分支 git checkout 功能/我的工作 ### 工作流程 5：合并后清理 # 1.切换到主程序 git checkout 主要 # 2.拉取最新的 git拉 # 3.删除本地分支 git分支-d功能/旧功能 # 4.删除远程分支（如果没有自动删除） git push origin --删除功能/旧功能 # 5. 修剪已删除的远程分支 git fetch --修剪 ### 工作流程 6：发布管理 # 1.创建发布标签 git tag -a v1.0.0 -m "发布 v1.0.0" git推送原点 v1.0.0 # 2. 创建 GitHub 版本 gh release create v1.0.0 --title "v1.0.0" --notes "发行说明" # 带有发布资产 gh release create v1.0.0 --title "v1.0.0" dist/*.tar.gz # 3. 列出版本 gh 发布列表 # 4. 查看版本 gh 发布视图 v1.0.0 ## 最佳实践 ### 分支命名使用描述性的、分类的名称： * `功能/用户身份验证` * `修复/登录错误` * `修补程序/关键安全问题` * `重构/清理-api` * `文档/更新自述文件` * `测试/添加集成测试` ### 提交指南 1. **对所有提交使用提交消息编写器代理** 2. **进行原子提交**：每次提交一个逻辑更改 3. **写清楚的信息**：解释原因，而不仅仅是解释什么 4. **参考问题**：包括相关的问题编号 5. **保持提交干净**：避免主要历史记录中的“WIP”或“修复拼写错误” ### 拉取请求实践 1. **保持 PR 的重点**：每个 PR 一个功能/修复 2. **写出好的描述**：解释什么、为什么以及如何测试 3. **定期更新** ：使分支与基础保持同步 4. **及时回复**：快速处理审稿意见 5. **使用草稿 PR**：用于进行中的工作反馈 ### Git 配置 # 设置用户信息 git config --global user.name“你的名字” git config --global user.email“you@example.com” # 设置默认分支名称 git config --global init.defaultBranch main # 设置拉动策略 git config --global pull.rebase true # 启用有用的颜色 git config --global color.ui auto # 设置默认编辑器 git config --global core.editor vim ## 常见模式 ### 模式 1：快速修复当前分支 git add <固定文件> # 使用提交消息写入代理 git 推送 ### 模式 2：与上游同步分叉 # 添加上游远程（一次） git 远程添加上游 # 获取并合并上游更改 git 获取上游 git checkout 主要 git 合并上游/主 git推送原点主要 ### 模式 3：合并前压缩提交 # 交互式变基到压缩（本地） git rebase -i HEAD~3 # 或者使用 PR 挤压合并（首选） gh pr 合并--squash ### 模式 4：查找谁更改了一行 # 指责文件 git 责备 <文件> git Blame -L 10,20 # 具体行 # 与 gh gh api repos/owner/repo/commits?path=<文件> | jq '.[0]' ### 模式 5：平分查找 Bug # 开始二等分 git 二等分开始 git bisect bad # 当前提交是错误的 git bisect good # 已知好的提交 # 测试 git 呈现的每个提交 # ...运行测试... git bisect 好 # 或坏 # 找到时 git 二分重置 ## 故障排除 ### 问题：合并冲突 # 1.查看冲突文件 git 状态 # 2.解决每个文件中的冲突 # ...编辑文件... # 3. 标记为已解决 git add <已解析的文件> # 4.继续操作 git rebase --continue # 如果变基 git commit # 如果合并 ### 问题：意外提交到错误的分支 # 1. 从当前状态创建新分支 git 分支正确分支 # 2. 重置当前分支 git 重置 --hard HEAD~1 # 3.切换到正确的分支 git checkout 正确的分支 ### 问题：推送敏感数据 # 1.从历史记录中删除 git filter-branch --tree-filter 'rm -f <文件>' HEAD # 或者使用 BFG Repo-Cleaner（更好） # bfg --delete-files <文件> # 2.强力推（与团队配合！） git 推送--强制 # 3.立即轮换任何暴露的秘密 ### 问题：需要更改上次提交 # 如果还没有推送 git commit --修改 # 如果已经推送（需要强制推送） git commit --修改 git push --force-with-lease git push --force-with-lease **警告**：仅在以下情况下修改： 1. 用户明确要求修改或 2. 从预提交挂钩添加编辑修改前务必检查作者身份： git log -1 --format='%an %ae' ### 问题：公关存在冲突 # 选项 1：在基础分支上重新建立基础 git 获取原点 git rebase 起源/主要 git push --force-with-lease git push --force-with-lease # 选项2：合并基础分支 git 获取原点 git 合并 origin/main git 推送 # 选项 3：使用 gh CLI gh pr 更新分支 123 ## Git 安全规则 1. **永远不要强制推送到 main/master** ：如果需要，警告用户 2. **永远不要跳过钩子**：除非明确要求，否则不要使用 --no-verify 3. **切勿运行破坏性命令**：未经用户确认 4. **修改前务必检查**：验证作者身份和推送状态 5. **使用 --force-with-lease** ：需要时代替 --force ## 与提交消息编写器集成验证之后和提交之前： # 所有更改准备就绪后 git 添加 . git status # 查看将要提交的内容 git diff --staged # 查看实际更改 # 然后使用提交消息编写器代理请求提交 # 代理将： # 1. 分析变化 # 2. 起草专业提交消息 # 3. 创建具有正确格式的提交 # 4. 无 AI 归因（根据 CLAUDE.md） ## 快速参考 # 状态和信息 git 状态 git log --oneline git 差异 # 分支机构 git checkout -b <分支> git push -u origin <分支> git 分支 -d <分支> # 提交 git 添加 . #（使用提交消息编写器） git 推送 # 拉取请求 gh 公关创建 gh 公关列表 gh 公关结账 123 gh pr 合并--squash # 问题 gh 问题创建 gh 问题列表 gh 问题视图 123 # 同步 git pull --rebase git fetch --修剪 # 清理 git 分支 -d <分支> git push origin --delete <分支> ## 总结 **主要指令：** 1. **始终使用提交消息编写器代理**进行提交 2. **使用gh CLI**进行GitHub操作 3. **遵循分支命名约定** 4. **保持提交的原子性和清晰性** 5. **切勿在提交消息中包含 AI 归属** 6. **小心破坏性操作** **最常用的命令：** * `git status` \- 检查状态 * `git checkout -b <分支>` \- 新分支 * `gh pr create` \- 创建 PR * `git pull --rebase` \- 保持更新 * `gh pr merge --squash` \- 合并 PR

git

包含技能