pr-creator

Pull Request 创建

此技能将指导你创建符合代码仓库规范的高质量 Pull Request。

工作流

按照以下步骤创建 Pull Request：

1. 分支管理：重要： 确保你当前不在 main 分支上工作。

   • 运行 git branch --show-current。
   • 如果当前分支是 main，你必须创建并切换到一个具有描述性的全新分支：

     git checkout -b <new-branch-name>
     

2. 提交更改：确认所有预期的更改均已提交。

   • 运行 git status，检查是否有未暂存或未提交的更改。
   • 如果有未提交的更改，请先暂存并使用描述性消息提交，然后再继续。绝不要直接提交到 main。

     git add .
     git commit -m "type(scope): description"
     

3. 查找模板：在代码仓库中查找 Pull Request 模板。

   • 检查 .github/pull_request_template.md
   • 检查 .github/PULL_REQUEST_TEMPLATE.md
   • 如果有多个模板（例如，在 .github/PULL_REQUEST_TEMPLATE/ 中），请询问用户要使用哪一个，或根据上下文选择最合适的模板（例如，bug_fix.md 与 feature.md）。

4. 阅读模板：阅读已找到的模板文件内容。

5. 起草描述：严格遵循模板的结构编写 PR 描述。

   • 标题：保留模板中的所有标题。
   • 检查清单：逐项检查。已完成的项目标记为 [x]。如果某项不适用，则保持未勾选或标记为 [ ]（根据模板说明），如果模板允许灵活处理，也可以移除该项（但为保持透明，优先保留未勾选状态）。
   • 内容：在各部分填写清晰、简洁的更改摘要。
   • 相关问题：关联已修复或与此 PR 相关的问题（例如，"Fixes #123"）。

6. 预检：创建 PR 前，运行工作区预检脚本，确保所有构建、lint 和测试检查均通过。

   npm run preflight
   

   如果任何检查未通过，请先解决问题，再创建 PR。

7. 推送分支：将当前分支推送到远程代码仓库。 重要安全措施： 推送前再次确认分支名称。 如果当前分支是 main，绝不要推送。

   # 确认当前分支不是 main
   git branch --show-current
   # 以非交互方式推送
   git push -u origin HEAD
   

8. 创建 PR：使用 gh CLI 创建 PR。为避免多行 Markdown 导致 shell 转义问题，请先将描述写入临时文件。

   # 1. 将起草好的描述写入临时文件
   # 2. 使用 --body-file 标志创建 PR
   gh pr create --title "type(scope): succinct description" --body-file <temp_file_path>
   # 3. 移除临时文件
   rm <temp_file_path>
   

   • 标题：如果代码仓库使用 Conventional Commits 格式，请确保标题遵循该格式（例如，feat(ui): add new button、fix(core): resolve crash）。

原则

• 安全第一：绝不要推送到 main。这是最高优先级。
• 遵循规范：绝不要忽略 PR 模板。模板的存在自有其原因。
• 完整性：填写所有相关部分。
• 准确性：不要勾选尚未完成的任务。