# @ezweave/what-name-branch

> Branch naming can be hard.

Latest version **1.1.10** (published 2023-07-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ezweave/what-name-branch
pnpm add @ezweave/what-name-branch
yarn add @ezweave/what-name-branch
bun add @ezweave/what-name-branch
```

Provides the command `name-branch`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.10 |
| Published | 2023-07-10 |
| First published | 2022-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 62.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Matt Weaver |
| Maintainers | ezweave |
| Keywords | git, jira, branch-name |

## Links

- npm: https://www.npmjs.com/package/@ezweave/what-name-branch
- Repository: git@github.com:ezweave/what-name-branch
- npm.io page: https://npm.io/package/@ezweave/what-name-branch

## Dependencies (6)

- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [yargs](https://npm.io/package/yargs.md) ^17.5.1
- [figlet](https://npm.io/package/figlet.md) ^1.5.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [inquirer](https://npm.io/package/inquirer.md) 8.0.0
- [node-emoji](https://npm.io/package/node-emoji.md) ^1.11.0

## Recent versions

- 1.1.10 (latest) — 2023-07-10
- 1.1.9 — 2023-07-10
- 1.1.8 — 2023-07-10
- 1.1.7 — 2022-08-01
- 1.1.6 — 2022-08-01
- 1.1.5 — 2022-07-29
- 1.1.4 — 2022-07-29
- 1.1.3 — 2022-07-29
- 1.1.2 — 2022-07-29
- 1.1.1 — 2022-07-29
- 1.1.0 — 2022-07-29
- 1.0.0 — 2022-07-29

## README

# what-name-branch

Hello reader!  How many times has this happened to you?  You're out walking your dog and your boss jumps out of a bush.

> Boss: "We've got a production bug you have to fix right now!"

You know the fix, but what to call it?  Do you include the issue title?  Will a short description be enough?

```shell
myCatsBreathSmells-like-cat-food
```

<p align="center">
  <img width="460" height="300" src="https://media.giphy.com/media/i4gLlAUz2IVIk/giphy.gif">
</p>

There's got to be a better way!

A much _saner_ approach is to just be opinionated and specific, which is what I've done!

## Table of Contents

* [Opinionated Branch Names](#opinionated-branch-names)
* [Installation](#installation)
* [Usage](#usage)

## Opinionated Branch Names

My favored approach to branch naming is three pieces, directly related to the issue (or whatever your software management suite calls it):

- `name`: what is the id used by your software management tool (aka Jira, etc)?
- `type`: of issue. Is this a bug, story, or a spike?
- `description`: the description from the title of the issue.

Simply put:

![](./docs/images/jira_issue.png)

I would name the branch: `story/PRP-42031169/i-needed-an-issue-for-a-screenshot-so-here-it-be`.

This tells me that it's a _story_, references the ID (in this case, the Jira one), and includes enough of a description where I can tell what I or someone else was doing.

In contrast to a branch name like: `PRP-42031169` or even `PRP-42031169/screenshot` it gives me a bit more context, especially if the branch hangs around for a bit (e.g. I am switching between branches, for some reason), and even helps after the branch is closed and merged.

This reduces "side trips" to Jira (in this case) to try and suss out just what the heck-poop you were doing with branch `fix-things` or whatever.

[Table of Contents](#table-of-contents)

## Installation

Via `npm`:

```shell
npm install -g @ezweave/what-name-branch
```

Via `yarn`:

```shell
yarn global add @ezweave/what-name-branch
```

[Table of Contents](#table-of-contents)

## Usage

```shell
name-branch
```

This will start asking you three short questions.

First, get the name/id from your software management tool (Jira, in our case):

![](./docs/images/branch_namer_name.png)

Second, select your issue type:

![](./docs/images/branch_namer_type.png)

Third, enter the description. `name-branch` will strip out unsafe characters and replace them with `-`, so go nuts:

![](./docs/images/branch_namer_description.png)

Now you have a branch name:

![](./docs/images/branch_namer_end.png)

Tada! Now you can get back to arguing about important things like `vim` vs `emacs`.

[Table of Contents](#table-of-contents)

---
_Source: https://npm.io/package/@ezweave/what-name-branch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._