# GitHub CLI 工作流程 ## 先决条件确保“gh”已通过身份验证： gh 身份验证状态 ## 问题 ### 创建问题 gh issues create --title "简要描述性标题" --body "$(cat <<'EOF' ## 总结用一段话描述需要做什么以及为什么。 ## 要求 - [ ] 要求 1 - [ ] 要求 2 - [ ] 要求 3 ## 验收标准 - [ ] 标准 1 - [ ] 标准 2 ## 注释其他上下文、链接或注意事项。 EOF )" --label "标签1,标签2" **问题标题约定：** * 以动作动词开头：添加、修复、更新、删除、重构、实施 * 具体一点：“添加用户身份验证”而不是“身份验证内容” * 保持在 72 个字符以内 ### 阅读问题 # 列出未解决的问题 gh 问题列表 # 带过滤器的列表 gh 问题列表 --label“bug”--assignee“@me” # 查看具体问题 gh 问题视图 123 # 查看评论 gh 问题视图 123 --comments ### 更新问题 # 添加标签 gh 问题编辑 123 --add-label“优先级：高，范围：mls” # 删除标签 gh 问题编辑 123 --remove-label "needs-triage" # 改变标题 gh issues edit 123 --title “新标题” # 添加到里程碑 gh 问题编辑 123 --milestone "v1.0" # 分配 gh 问题编辑 123 --add-受让人“@me” ### 关闭问题 # 有理由地结束 gh 问题关闭 123 --原因已完成 # 未按计划关闭 gh 问题关闭 123 --原因“未计划” ## 标签 ### 创建标签 gh 标签创建“范围：功能名称”--描述“X 的功能”--颜色“0052CC” **标签命名约定：** * 使用带冒号的前缀：`scope:`、`priority:`、`type:`、`status:` * 带连字符的小写字母：`scope:user-auth` * 常用前缀： * `类型：bug`、`类型：功能`、`类型：重构`、`类型：文档` * `优先级：高`、`优先级：中`、`优先级：低` * `范围：mls`，`范围：mls后` * `状态：已阻止`、`状态：审核中` ### 列出标签 gh 标签列表 ### 更新标签 gh label edit "old-name" --name "new-name" --description "更新的描述" --color "FF0000" ### 删除标签 gh 标签删除“标签名称”--是 ## 拉取请求 ### 确定基础分支 **关键：在创建 PR 之前始终验证正确的基础分支。** # 检查当前分支 git 分支 --显示当前 # 查看你从哪个分支分支出来 git log --oneline --graph -10 # 列出远程分支 git 分支 -r # 公共基础分支：main、master、develop、release/* ### 创建 PR（结束问题） **PR 必须引用他们使用结束关键字实现的问题。** gh 公关创建\ --基地开发\ --title "添加用户身份验证" \ --body "$(猫 <<'EOF' ## 总结简要描述此 PR 的作用。 ## 变化 - 变更1 - 改变2 - 改变3 ## 关闭关闭 #123 关闭#124 ## 测试 - [ ] 添加/更新了单元测试 - [ ] 手动测试完成 - [ ] 无回归 ## 截图（如适用） EOF ）” **结束关键词（其中任何一个都有效）：** * `关闭 #123` * `修复#123` * `解决#123` **公关标题约定：** * 匹配问题标题或总结变更 * 使用祈使语气：“添加功能”而不是“添加功能” * 保持在 72 个字符以内 ### 从问题创建 PR 在实现问题时，正确引用它： # 首先获取问题详细信息 gh 问题视图 123 # 创建以问题命名的分支 git checkout -b 123-add-user-auth # 提交后，创建 PR gh 公关创建\ --基本主\ --title "添加用户身份验证" \ --body "$(猫 <<'EOF' ## 总结使用 JWT 令牌实现用户身份验证。 ## 关闭关闭 #123 ## 变化 - 添加了身份验证中间件 - 添加了登录/注销端点 - 添加了 JWT 令牌生成 ## 测试 - [ ] 单元测试通过 - [ ] 集成测试通过 EOF ）” ### 阅读 PR # 列出开放的 PR gh 公关列表 # 查看具体PR gh 公关视图 456 # 查看公关差异 gh 公关差异 456 # 查看 PR 检查 gh 公关检查 456 # 查看公关评论 gh api 存储库/{owner}/{repo}/pulls/456/comments ### 更新公关 # 改变标题 gh pr edit 456 --title “新标题” # 添加审稿人 gh pr 编辑 456 --add-reviewer "用户名1，用户名2" # 添加标签 gh pr 编辑 456 --add-label“准备审查” # 更改基础分支 gh pr 编辑 456 --基础开发 ### 合并公关 # 合并（创建合并提交） gh pr 合并 456 --merge # 挤压合并（单个提交） gh pr 合并 456 --squash # 变基合并 gh pr 合并 456 --rebase # 合并后删除分支 gh pr 合并 456 --squash --删除分支 ### 关闭 PR 而不合并 gh 公关关闭 456 ## 完整的工作流程示例 ### 功能开发流程 # 1. 创建问题 gh 问题创建 \ --title“添加暗模式切换”\ --label“类型：功能，范围：mls”\ --body "$(猫 <<'EOF' ## 总结在用户设置中添加暗模式切换。 ## 要求 - [ ] 设置中的切换开关 - [ ] 保留偏好 - [ ] 立即应用主题 ## 验收标准 - [ ] 用户可以切换暗模式 - [ ] 偏好在会话中保持不变 EOF ）” # 返回：创建问题 #167 # 2.创建功能分支 git checkout -b 167-add-dark-mode git checkout -b 167-add-dark-mode # 3. 进行更改并提交 git 添加 . git commit -m“添加暗模式切换组件” # 4. 推送并创建 PR git push -u origin 167-add-dark-mode gh 公关创建\ --基本主\ --title“添加暗模式切换”\ --body "$(猫 <<'EOF' ## 总结将深色模式切换添加到具有持久首选项的用户设置。 ## 关闭关闭#167 ## 变化 - 添加了 DarkModeToggle 组件 - 添加了主题上下文提供程序 - 添加了 localStorage 持久性 ## 测试 - [x] 添加单元测试 - [x] 手动测试已完成 EOF ）” # 5.审核后，合并 gh pr 合并 --squash --删除分支 ## 提示 ### 批量操作 # 关闭多个问题对于101 102 103中的i； gh 问题关闭 $i;完成 # 为多个问题添加标签对于101 102 103中的i；做 gh 问题编辑 $i --add-label "wontfix";完成 ### 用于脚本编写的 JSON 输出 # 获取 JSON 格式的问题数据 gh 问题视图 123 --json 数字、标题、标签、状态 # 以 JSON 形式列出 PR gh pr list --json 数字,标题,headRefName,baseRefName ### 检查仓库上下文 # 验证您正在使用哪个存储库 gh 仓库视图 --json nameWithOwner

Github CLI

包含技能