# branch-namer

**Repository Path**: kenann/branch-namer

## Basic Information

- **Project Name**: branch-namer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-23
- **Last Updated**: 2026-06-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Branch Namer

`branch-namer` 是一个 Codex 插件，用来根据功能描述生成符合项目习惯的 Git 分支名。

它适合在新建功能分支、修复分支、热修分支或日常任务分支前使用。插件会结合当前仓库已有分支命名方式，生成包含类型、功能描述、日期和开发者姓名缩写的分支名。

## 功能

- 根据中文或英文需求描述生成分支名。
- 自动判断常见分支类型，例如 `feat`、`fix`、`hotfix`、`chore`、`refactor`、`docs`。
- 将中文功能描述转换为简洁英文 slug。
- 优先参考当前仓库已有分支命名风格。
- 支持生成包含日期和开发者姓名缩写的分支名。
- 针对 `car-trailer-client` 项目，优先使用以下格式：

```text
type/feature_slug_YYYYMMDD_initials
```

示例：

```text
feat/mp_subscribe_message_20260623_wd
feat/mp_no_price_order_compatibility_20260623_lyx
fix/style_issue_adjust_20260130_wd
```

## 安装

在 Codex CLI 中添加这个插件市场：

```bash
codex plugin marketplace add https://gitee.com/kenann/branch-namer.git
```

添加完成后，在 Codex 插件市场里找到并安装 `branch-namer`。

## 在 Codex 桌面端显示插件

如果想让 `branch-namer` 出现在 Codex 桌面端插件市场中，先在本机终端执行安装命令：

```bash
codex plugin marketplace add https://gitee.com/kenann/branch-namer.git
```

然后打开 Codex 桌面端，在插件或插件市场页面中查找 `branch-namer` 并安装或启用。

如果桌面端已经打开但没有立刻显示，可以尝试以下操作：

- 重新打开 Codex 桌面端。
- 在插件市场页面刷新列表。
- 确认命令执行成功，并且仓库地址没有输错。

安装完成后，新开的 Codex 会话即可使用 `branch-namer`。如果当前会话已经在运行，建议新开一个会话再使用。

## 使用

安装后，可以直接让 Codex 使用插件生成分支名。

示例 1：

```text
给起一个分支名，主要做小程序订阅消息开发，开发者是王东。
```

可能输出：

```text
feat/mp_subscribe_message_20260623_wd
```

示例 2：

```text
给起一个分支名，主要做小程序兼容无价格订单的，开发者是李雨溪。
```

可能输出：

```text
feat/mp_no_price_order_compatibility_20260623_lyx
```

也可以显式调用技能：

```text
Use $branch-namer to name a branch for 小程序兼容无价格订单，开发者李雨溪。
```

## 命名规则

默认规则：

```text
类型/功能_slug_日期_开发者缩写
```

字段说明：

- `类型`：根据任务性质选择，常见值包括 `feat`、`fix`、`hotfix`、`chore`。
- `功能_slug`：从功能描述中提取的简洁英文关键词。
- `日期`：使用 `YYYYMMDD` 格式。
- `开发者缩写`：优先使用用户提供的姓名或缩写推断，例如李雨溪对应 `lyx`。

## 注意事项

- 插件只负责生成分支名，不会自动创建、切换或推送 Git 分支。
- 如果仓库已有明显命名习惯，插件会优先贴合当前仓库风格。
- 如果日期或开发者缩写无法安全推断，Codex 会先询问补充信息。

## 更新

如果插件仓库后续有更新，可以重新升级已添加的插件市场：

```bash
codex plugin marketplace upgrade
```