https://github.com/motemen/hub-pr

Personal workflow handling GitHub Pull Requests
https://github.com/motemen/hub-pr

Last synced: 3 months ago
JSON representation

Personal workflow handling GitHub Pull Requests

• Host: GitHub
• URL: https://github.com/motemen/hub-pr
• Owner: motemen
• Created: 2015-03-20T05:03:10.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-02-27T03:37:04.000Z (almost 6 years ago)
• Last Synced: 2024-05-01T23:31:13.932Z (9 months ago)
• Language: Go
• Size: 1.18 MB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

        
= hub-pr

Personal workflow for handling pull requests on open-source projects

== Installation

----

go get github.com/motemen/hub-pr

----

== Usage

----

Usage: hub-pr  []

Commands:

    browse      Open pull request page with browser

    diff        Show pull request's diff

    checkout    Checkout a branch for a pull request

    list        List pull requests

    merge       Merge a branch of a pull request

----

== Description

hub-pr supports a certain way handling pull requests from forked repository. Especially, it provides a way to check out the pull request locally so that you can append commits upon it.

=== Checking out a Pull Request branch

----

hub-pr checkout PULL_REQUEST_NUMBER

----

Will do below:

* Add a remote pointing forked repository with the name of the pull request author

* Check out a new branch tracking pull request's head branch named

  `#-/`, e.g. `#23-motemen/fix`.

* Stores the pull request number as `branch..prNumber` into local configuration for later reference.

=== Merging a Pull Request branch

----

hub-pr merge BRANCH

----

Will invoke a normal git-merge with a commit message same as what will used

when hitting the Merge Button on the GitHub web. The branch must be checked out with `hub-pr checkout`.

=== Showing a Pull Request's diff

----

hub-pr diff

----

Runs "git diff" between the base and head of the Pull Reuqest corresponding current branch.

== Author

motemen