GitHub PR Helper

GitHub PR Helper

site icon
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 的创建和代码审查流程,提高开发效率。

核心功能

  1. 创建 GitHub Pull Request:根据提供的标题、描述、票号和目标分支,自动创建 GitHub PR。
  2. Code Review:在 PR 中添加评论,方便进行代码审查。

适用场景

  1. 团队协作开发时,快速创建 PR 并进行代码审查。
  2. 自动化处理 GitHub 相关操作,减少手动操作。

工具列表

  1. create_pull_request:创建 GitHub Pull Request。
  2. 参数:repoPath, title, description, ticketNumber, baseBranch
  3. add_pr_comment:在 PR 中添加评论。
  4. 参数:repoPath, baseBranch, filePath, lineNumber, comment

常见问题解答

  1. 如何确保工具正常工作?
  2. 确保已安装并登录 GitHub CLI (gh auth login)。
  3. 确保本地 Git 仓库已提交所有更改并推送到远程仓库。
  4. 遇到权限问题怎么办?
  5. 检查 GitHub CLI 登录状态 (gh auth status)。

使用教程

使用依赖

  1. 安装 GitHub CLI
  2. macOS: brew install gh
  3. Windows: winget install --id GitHub.cli
  4. Linux: 参考 GitHub CLI 官方文档
  5. 登录 GitHub CLIgh auth login

安装教程

  1. 安装依赖: npm install
  2. 配置环境变量(可选):
  3. .env 文件中设置 PORT(默认 3000)。

调试方式

  1. 开发模式npm run dev
  2. 生产模式npm start
  3. MCP 服务npm run mcp

许可证

None