@@ -24,26 +24,37 @@ description: 使用 GitHub CLI 与 GitHub 资源交互;适用于 repo、issue
2424- Release 列表:` gh release list `
2525- Workflow 列表:` gh workflow list `
2626
27+ ## 创建前通用检查
28+ 在创建 Issue 或 PR 前,先检查仓库规范、模板或表单;若仓库另有要求,以仓库要求为准。
29+ 1 . 优先查这些位置:` CONTRIBUTING.md ` 、` README.md ` 中的贡献说明、` .github/ISSUE_TEMPLATE/ ` 、` .github/ISSUE_TEMPLATE.md ` 、` .github/PULL_REQUEST_TEMPLATE.md ` 、` .github/pull_request_template.md ` 、` .github/PULL_REQUEST_TEMPLATE/ ` 、` .github/config.yml ` 、issue / PR form 模板、` CODEOWNERS ` ,以及仓库里与提交规范或分支策略相关的说明。
30+ 2 . 若仓库要求特定标题格式、正文结构、关联 issue、检查项、标签、base 分支、签名提交、提交历史整理方式、测试/文档要求或其它必填字段,先按仓库要求准备,再补充本 skill 的默认格式。
31+ 3 . 在正式创建前检查本地状态是否匹配这些要求:相关代码、当前分支、提交标题/历史、测试、文档与变更说明是否一致且完整。
32+
2733## 创建 Issue(非交互)
28- 1 . 标题与描述风格同 PR,内容保持简洁清晰。
29- 2 . 使用非交互方式创建,避免进入编辑器或依赖手工输入。
30- 3 . 创建成功后,输出完整 Issue URL。
34+ 以下规范建立在“创建前通用检查”已完成的前提上。
35+ 1 . 若仓库要求 issue 必须包含特定字段、标签、复现步骤、版本信息、最小示例或分类,先据此整理内容;不要跳过必填项。
36+ 2 . 若 issue 与当前本地改动或分支上下文有关,先检查相关代码、分支与提交信息,确认 issue 描述与现状一致,不要提交已经过时或与代码不符的内容。
37+ 3 . 标题与描述风格同 PR,内容保持简洁清晰。
38+ 4 . 使用非交互方式创建,避免进入编辑器或依赖手工输入。
39+ 5 . 创建成功后,输出完整 Issue URL。
3140
3241## 创建 PR
3342以下标题与描述规范为默认推荐格式;如与团队/仓库/平台等既有约束冲突,以既有约束为准。若有明确要求(如需中文),则优先遵循。
34- 1 . 确认 ` git status ` 干净,` git push ` 到远端。
35- 2 . 标题风格:英文、遵循语义化提交规范(如 ` feat(scope): short summary ` ),简洁且描述核心目的;即使标题要求中文,语义化前缀仍需英文。
36- 3 . 描述风格:英文、短句和项目符号,优先让不看代码的读者快速理解动机、改动与验证方式。重点是 what/why/testing,避免流水账与过多实现细节。若上下文不足以明确目标或约束,应主动向开发者确认后再撰写。涉及专有名词、函数名、方法名、类名、API 名称或配置键时,使用 inline code(反引号)包裹以提升可读性与准确性。
37- 4 . 默认正文格式:
43+ 1 . 先完成“创建前通用检查”。
44+ 2 . 只有在确认仓库要求与本地代码/提交状态都满足后,才创建 PR;若发现不满足,应先修正,再创建。
45+ 3 . ` git status ` 必须干净,且当前分支已推送到远端。
46+ 4 . 标题风格:英文、遵循语义化提交规范(如 ` feat(scope): short summary ` ),简洁且描述核心目的;即使标题要求中文,语义化前缀仍需英文。
47+ 5 . 描述风格:英文、短句和项目符号,优先让不看代码的读者快速理解动机、改动与验证方式。重点是 what/why/testing,避免流水账与过多实现细节。若上下文不足以明确目标或约束,应主动向开发者确认后再撰写。涉及专有名词、函数名、方法名、类名、API 名称或配置键时,使用 inline code(反引号)包裹以提升可读性与准确性。
48+ 6 . 默认正文格式:
3849 - ` ## Why ` :1-2 条短句说明为什么要做这次改动,聚焦问题背景或目标。
3950 - ` ## What ` :1-3 条说明主要变更,聚焦功能或行为层面的变化,不罗列琐碎实现细节。
4051 - ` ## Testing ` :说明验证方式、命令或场景;未测试需注明原因。
41- 5 . 可选正文块:仅在确有必要时再添加。
52+ 7 . 可选正文块:仅在确有必要时再添加。
4253 - ` ## Risks ` :兼容性影响、潜在风险、回滚注意事项。
4354 - ` ## Notes ` :reviewers 需要特别关注的点,或后续计划。
44- 6 . 使用非交互式命令创建 PR,避免进入交互式编辑流程;按需补充 base、draft 等参数。
45- 7 . 修改 PR 时复用与创建时一致的非交互方式,避免手工编辑。
46- 8 . 创建成功后,输出完整 PR URL。
55+ 8 . 使用非交互式命令创建 PR,避免进入交互式编辑流程;按需补充 base、draft 等参数。
56+ 9 . 修改 PR 时复用与创建时一致的非交互方式,避免手工编辑。
57+ 10 . 创建成功后,输出完整 PR URL。
4758
4859## 更新 Issue/PR 标题或描述(前置要求)
4960在更新 Issue 或 PR 的标题/描述之前,必须先读取当前标题/正文(即将被修改的内容),再进行修改。
0 commit comments