# @eric.dahlseng/pull-request

> Pull Request

Latest version **0.1.1** (published 2020-02-13) · 0 weekly downloads

## Install

```sh
npm install @eric.dahlseng/pull-request
pnpm add @eric.dahlseng/pull-request
yarn add @eric.dahlseng/pull-request
bun add @eric.dahlseng/pull-request
```

Provides the command `pull-request`.

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2020-02-13 |
| First published | 2020-02-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 51.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | eric.dahlseng |

## Links

- npm: https://www.npmjs.com/package/@eric.dahlseng/pull-request
- npm.io page: https://npm.io/package/@eric.dahlseng/pull-request

## Dependencies (6)

- [ramda](https://npm.io/package/ramda.md) ^0.25.0
- [fluture](https://npm.io/package/fluture.md) ^8.0.2
- [fantasy-land](https://npm.io/package/fantasy-land.md) ^3.5.0
- [fantasy-combinators](https://npm.io/package/fantasy-combinators.md) 0.0.1
- [@eric.dahlseng/cli-tools](https://npm.io/package/@eric.dahlseng/cli-tools.md) ^0.1.0
- [@eric.dahlseng/standard-version](https://npm.io/package/@eric.dahlseng/standard-version.md) ^1.1.0

## Recent versions

- 0.1.1 (latest) — 2020-02-13
- 0.1.0 — 2020-02-13

## README

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:

```shell
alias pr='pull-request'
```

Usage
-----

```shell
pull-request <action>
```

Actions:
* `<none>`: Rebases against upstream, runs checks, and opens a pull request
* `branch`: Creates a new branch to work in
* `setup`: Creates a fork and sets up remotes

### Submitting a pull request

```shell
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

```shell
pull-request branch
```

When called inside of a Git repository, this command will:
* Prompt for a branch type (bugfix, dependency, feature, tech-debt, <none>)
* 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

---
_Source: https://npm.io/package/@eric.dahlseng/pull-request · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._