
GitHub PR Helper

2025.03.14
0
JavaScriptGitHub PR 创建代码审查工具开发效率
GitHub PR Helper 是一个基于 GitHub CLI (`gh`) 的命令行工具,用于简化 GitHub Pull Request 的创建和代码审查流程。它通过自动化处理权限和 PR 创建过程,提高了开发效率。
View on GitHub
Overview
基本能力
产品定位
GitHub PR Helper 是一个专为开发者设计的工具,旨在简化 GitHub Pull Request 的创建和代码审查流程,提高开发效率。
核心功能
- 创建 GitHub Pull Request:根据提供的标题、描述、票号和目标分支,自动创建 GitHub PR。
- Code Review:在 PR 中添加评论,方便进行代码审查。
适用场景
- 团队协作开发时,快速创建 PR 并进行代码审查。
- 自动化处理 GitHub 相关操作,减少手动操作。
工具列表
create_pull_request
:创建 GitHub Pull Request。- 参数:
repoPath
,title
,description
,ticketNumber
,baseBranch
add_pr_comment
:在 PR 中添加评论。- 参数:
repoPath
,baseBranch
,filePath
,lineNumber
,comment
常见问题解答
- 如何确保工具正常工作?
- 确保已安装并登录 GitHub CLI (
gh auth login
)。 - 确保本地 Git 仓库已提交所有更改并推送到远程仓库。
- 遇到权限问题怎么办?
- 检查 GitHub CLI 登录状态 (
gh auth status
)。
使用教程
使用依赖
- 安装 GitHub CLI:
- macOS:
brew install gh
- Windows:
winget install --id GitHub.cli
- Linux: 参考 GitHub CLI 官方文档
- 登录 GitHub CLI:
gh auth login
安装教程
- 安装依赖:
npm install
- 配置环境变量(可选):
- 在
.env
文件中设置PORT
(默认 3000)。
调试方式
- 开发模式:
npm run dev
- 生产模式:
npm start
- MCP 服务:
npm run mcp
许可证
None