mcpField
C
creating-pr

creating-pr

github.com/revitalb-port开发081 次安装11 周前更新
代码仓库

关于 creating-pr

用于准备和创建便于审查的拉取请求的开发 skill，涵盖分支准备、标题与描述规范、自检、创建 PR 及请求审阅。

主要功能

  1. 01创建 PR 前更新并检查分支
  2. 02采用规范的 PR 标题和描述
  3. 03审查差异并检查测试、类型和 lint
  4. 04使用 GitHub CLI 创建 PR
  5. 05请求审阅者并添加标签

适用场景

  1. 01为拉取请求准备分支
  2. 02检查改动并运行项目验证
  3. 03编写结构化 PR 描述
  4. 04安排大型或有依赖关系的 PR 审查

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/revitalb-port/skills-registry-demo --skill creating-pr

安装后在 Claude Code 中输入/creating-pr确认已加载。

详细介绍

创建 PR

将工作打包成便于审查和合并的拉取请求。

工作流

1. 准备分支

创建 PR 前：

# Ensure branch is up to date with base
git fetch origin
git rebase origin/main  # or merge, depending on project convention

# Check what will be in the PR
git log origin/main..HEAD --oneline
git diff origin/main --stat

如果项目偏好干净的历史记录，请压缩修正提交。如果项目偏好细粒度的历史记录，请保留逻辑上独立的提交。

2. 编写标题

格式：<type>: <short description>

类型适用场景
feat新功能
fix修复错误
refactor既不修复错误也不添加功能的代码更改
docs仅文档更改
test添加或修复测试
chore构建、CI、依赖项或工具
perf性能改进

示例：

  • feat: add dark mode toggle to settings page
  • fix: prevent duplicate form submissions on checkout
  • refactor: extract auth middleware into shared module
3. 编写描述

使用以下结构：

## Summary

1-3 sentences explaining what this PR does and why.

Closes #123

## Changes

- Added `ThemeToggle` component with system/light/dark options
- Updated `Layout` to read theme from context
- Added theme persistence to localStorage

## Test Plan

- [ ] Toggle between light/dark/system themes
- [ ] Refresh page — theme persists
- [ ] Check no flash of unstyled content on load
4. 自我审查

请求审查前：

  • 逐行自行阅读差异
  • 移除调试代码（console.log、TODO、已注释掉的代码）
  • 确认测试通过：npm test
  • 确认类型无误：npx tsc --noEmit
  • 确认 lint 检查通过：npm run lint
  • 检查不应提交的文件（.env、锁文件冲突）
5. 创建 PR
git push -u origin HEAD
gh pr create --title "<title>" --body "$(cat <<'EOF'
## Summary
...

## Changes
...

## Test Plan
...
EOF
)"
6. 请求审查
  • 标记合适的审查者（代码所有者、领域专家）
  • 如果 PR 较大（>400 行），添加评论说明审查文件的最佳顺序
  • 如果 PR 依赖另一个 PR，请在描述中注明
  • 为 PR 添加适当的标签（功能、错误、破坏性更改等）

提示

  • 小型 PR 审查更快——尽量将更改控制在 <300 行
  • 如果 PR 太大，请将其拆分为多个堆叠 PR
  • UI 更改附上截图或录屏，可以大幅加快审查
  • 草稿 PR 适合在工作完成前获取早期反馈

评论

支持 Markdown