很好,这一步做对了会直接提升你这个框架的“专业度”和长期维护体验。我给你一套**非常适合 Colleen 这种框架项目的 commit + release 规范**,尽量做到:简单、可自动化、对用户友好。
---
# 🚀 一套适合你 Colleen 的完整规范
## 1️⃣ Commit 规范(核心)
采用 **Conventional Commits(简化版)**:
### ✅ 标准格式
```bash
<type>(scope): <summary>
```
---
## 2️⃣ type 设计(给你精简过的版本)
你不需要太多类型,这几个够了:
| type | 用途 | 示例 |
| -------- | --------- | ---------------------- |
| feat | 新功能 | WebSocket 支持 |
| fix | bug 修复 | 修复路由匹配问题 |
| perf | 性能优化 | 减少对象分配 |
| refactor | 重构(无功能变化) | 重写 middleware pipeline |
| docs | 文档 | README 更新 |
| test | 测试 | 增加测试 |
| chore | 构建/版本/杂项 | bump version |
---
## 3️⃣ scope(非常关键,强烈建议你用)
你的框架可以这样设计 scope:
| scope | 含义 |
| ---------- | --------- |
| core | 核心 |
| http | HTTP |
| websocket | WebSocket |
| routing | 路由 |
| middleware | 中间件 |
| config | 配置 |
| build | 构建 |
---
## ✅ 示例(非常贴近你这次改动)
```bash
feat(websocket): add WebSocket support
```
```bash
chore(release): bump version to 0.4.0
```
```bash
docs(readme): update version to 0.4.0
```
---
# 4️⃣ Release 版本规范(语义化版本)
你现在从 `0.3.9 → 0.4.0` 是完全正确的 👇
| 版本 | 含义 |
| ---------------------- | --------------- |
| PATCH (0.3.9 → 0.3.10) | bug 修复 |
| MINOR (0.3.9 → 0.4.0) | 新功能 ✅ |
| MAJOR (0.x → 1.0) | breaking change |
👉 WebSocket = **典型 MINOR**
---
# 5️⃣ 推荐的 Git 提交流程(非常关键)
### ✅ 标准流程(强烈建议)
```bash
# 1. 功能
feat(websocket): add WebSocket support
# 2. 文档
docs(readme): add WebSocket usage example
# 3. 发布
chore(release): bump version to 0.4.0
```
---
# 6️⃣ 自动生成 CHANGELOG(重点)
如果你按这个规范写 commit,可以自动生成:
```md
## v0.4.0
### ✨ Features
- add WebSocket support
### 📝 Docs
- update README
### 🔧 Chore
- bump version to 0.4.0
```
---
# 7️⃣ GitHub Release 模板(我帮你写好了)
你可以直接用👇
```md
## 🚀 Colleen v0.4.0
### ✨ Features
- WebSocket support
### 📦 Changes
- bump version to 0.4.0
- update README
### 💡 Notes
This release introduces native WebSocket support, enabling real-time communication capabilities in Colleen.
---
```
---
# 8️⃣ 是否要上自动化(建议你做)
如果你想更专业一点,可以加:
### 👉 工具推荐
* `commitlint`(校验 commit)
* `standard-version` 或 `semantic-release`
---
# 🎯 给你的最终建议(最实用)
你现在直接这样用就够了:
### ✅ 日常开发
```bash
feat(websocket): add WebSocket support
fix(routing): fix path matching bug
```
### ✅ 发版
```bash
chore(release): bump version to 0.4.0
```
---
# 💬 最关键的一句话
👉 **commit 是写给未来的你 + 用户看的,不是写给 git 的**
你现在这个项目已经开始有“框架味”了,这套规范会让它看起来**非常专业(像 Ktor / Spring 那种级别)**。
---
如果你下一步要做,我可以帮你补:
✅ 自动生成 changelog
✅ GitHub Action 自动发版
✅ README 徽章(version / downloads)
✅ 甚至帮你设计 1.0 roadmap
直接说一声你想做到哪一步 👍