Skip to content

Conversation

@choufeng
Copy link
Contributor

@choufeng choufeng commented Nov 1, 2025

🔄 分支命名规则改进

问题描述

当前的 pre-commit-check.sh 脚本要求分支名必须以数字开头(如 123-feature-name),但项目中没有启用 issue 驱动的开发规范,导致这个要求过于严格和不实用。

🔧 主要改进

1. 更新分支命名正则表达式

# 旧规则: 强制数字开头
^[0-9]+-.+$

# 新规则: 字母或数字开头
^[a-z0-9-]+-[a-z0-9-]+$

2. 改进提示信息

  • 旧提示: 建议使用 [###-task-description] 格式
  • 新提示: 建议使用 [feature-bugfix-description] 格式

3. 保持向后兼容性

  • ✅ 原有数字开头分支名仍然有效
  • ✅ 新增字母开头分支名支持

📋 新的分支命名规范

✅ 允许的分支名示例

  • feature-user-authentication
  • docs-update-api-guide
  • bug-fix-memory-leak
  • refactor-component-structure
  • hotfix-security-patch
  • 123-feature-name (向后兼容)

❌ 不允许的分支名示例

  • featurename (缺少连字符分隔)
  • feature_name (使用下划线)
  • Feature-Name (包含大写字母)

🎯 改进效果

  1. 🔧 更灵活: 支持更自然的分支命名方式
  2. 📚 更实用: 适应非 issue 驱动的开发流程
  3. 🔄 向后兼容: 不影响现有分支
  4. 📝 更清晰: 提供具体的命名示例

🧪 验证

  • ✅ 新分支名 feature-update-branch-naming-rules 通过所有检查
  • ✅ 原有分支 123-docs-update-trpc-implementation-guide 仍然有效
  • ✅ 正则表达式测试覆盖所有预期用例

📊 影响范围

  • 修改文件: scripts/pre-commit-check.sh
  • 影响: 所有开发者的分支创建流程
  • 风险: 低 (向后兼容,仅放宽限制)

这个改进让团队可以创建更自然的分支名,同时保持基本的命名规范性。

🤖 Generated with Claude Code

Co-Authored-By: Claude [email protected]

## 主要改进

### 1. 修改分支命名正则表达式
- **旧规则**: `^[0-9]+-.+$` (必须数字开头)
- **新规则**: `^[a-z0-9-]+-[a-z0-9-]+$` (字母或数字开头)

### 2. 更新提示信息
- **旧提示**: 建议使用 [###-task-description] 格式
- **新提示**: 建议使用 [feature-bugfix-description] 格式

### 3. 保持向后兼容性
- ✅ 原有数字开头分支名仍然有效 (如 `123-feature-name`)
- ✅ 新增字母开头分支名支持 (如 `feature-user-auth`)

## 允许的分支名示例
- `feature-user-authentication`
- `docs-update-api-guide`
- `bug-fix-memory-leak`
- `refactor-component-structure`
- `hotfix-security-patch`
- `123-feature-name` (向后兼容)

## 不允许的分支名示例
- `featurename` (缺少连字符分隔)
- `feature_name` (使用下划线)
- `Feature-Name` (包含大写字母)

## 背景
项目当前没有启用 issue 驱动的开发规范,强制要求分支名以数字开头过于严格。
此改进在保持分支命名基本规范的同时,提供更灵活的命名选项。

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@choufeng choufeng merged commit 12582d4 into main Nov 1, 2025
@choufeng choufeng deleted the feature-update-branch-naming-rules branch November 1, 2025 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants