0.1.1 • Published 4 years ago
@eric.dahlseng/pull-request v0.1.1
pull-request
pull-request is a helper script for common repository actions related to creating and submitting pull-requests.
Installation
TODO
Optional:
It's recommended to create an alias for pull-request:
alias pr='pull-request'
Usage
pull-request <action>
Actions:
<none>
: Rebases against upstream, runs checks, and opens a pull requestbranch
: Creates a new branch to work insetup
: Creates a fork and sets up remotes
Submitting a pull request
pull-request
When called inside of a Git repository, this command will:
- Rebase the current branch off of the upstream master branch
- Run checks
- Push the updated branch to the origin remote
- Open a pull request on GitHub
Assumptions:
TODO
Creating a branch
pull-request branch
When called inside of a Git repository, this command will:
- Prompt for a branch type (bugfix, dependency, feature, tech-debt, )
- Prompt for a branch subname
- Create a new branch named
<branch type>/<branch subname>
- Push the newly created branch to the origin remote
Assumptions:
TODO
Setting up a repository
TODO