Skip to content

richardgaunt/github-pr-maker

Repository files navigation

🚀 GitHub PR Maker

Tests CodeRabbit Pull Request Reviews

🎯 GitHub PR Maker generates PRs using your commit history and a standardized template.

🛠️ How It Works

The app will prompt you for:

  1. 🎫 Ticket number (e.g., JIRA-123)
  2. 📝 Pull Request title
  3. ✅ Whether your changes include tests
  4. 🔄 Which recent commits to include (with ability to edit descriptions)

It then:

  • 📋 Generates a PR using your template with all provided information

🚀 Usage

gh-pr-2025-05-26_14.00.23.mp4

Method 1: Local Installation

# Install dependencies
npm install

# Run the PR maker
npm start

Method 2: Command Line Installation

You can install this tool globally to use it from anywhere:

# Install globally
npm install -g .

# Run from anywhere
gh-pr

Method 3: Bash Alias

You can also create a bash alias to run the tool:

# Add to your ~/.bashrc or ~/.zshrc
alias gh-pr="node /path/to/github-pr-builder/index.js"

# Then reload your shell
source ~/.bashrc  # or source ~/.zshrc

🧪 Development

# Run tests
npm test

# Check code style
npm run lint

📝 License

MIT

About

GitHub PR Maker generates a PR using a standard PR template and your input.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published