mcpField
C
creating-pr

creating-pr

github.com/spencerpauly开发868470 次安装13 周前更新
代码仓库

关于 creating-pr

一项将工作整理为拉取请求的技能，涵盖更新分支、编写标题、自查和请求评审，帮助开发者准备更易审查和合并的改动。

主要功能

  1. 01与基准分支变基或合并
  2. 02检查提交和差异规模
  3. 03按改动类型编写标题
  4. 04组织 PR 描述
  5. 05检查测试、类型、Lint 和差异
  6. 06使用 gh 创建 PR

适用场景

  1. 01为功能或修复准备评审
  2. 02创建 PR 前检查分支
  3. 03将大型改动整理为易审查的内容

安装

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

$npx skills add https://github.com/spencerpauly/awesome-cursor-skills --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