📝 docs(playbook): add contributing and multi-language standards
Introduce C++ and Python docs/templates and split .agents rulesets by language (tsl/cpp/python). Move commit message guidance to CONTRIBUTING.md (full spec remains in docs/common/commit_message.md).
This commit is contained in:
@@ -10,9 +10,9 @@
|
||||
|
||||
## 2. 格式
|
||||
|
||||
推荐使用以下结构(emoji 可选):
|
||||
推荐使用以下结构(emoji 可选,但建议默认带上以便快速扫读):
|
||||
|
||||
```
|
||||
```txt
|
||||
:emoji: type(scope): subject
|
||||
|
||||
body
|
||||
@@ -20,7 +20,7 @@ body
|
||||
footer
|
||||
```
|
||||
|
||||
- `emoji`:可选,位于首行行首;若使用,必须与 `type` 一一对应(见 4)。
|
||||
- `emoji`:可选,位于首行行首;若使用,必须与 `type` 一一对应(见 4)。为保持一致性,建议默认使用 emoji;若不使用则省略即可。
|
||||
- `type`:变更类型,必须从 4 的对应表中选取。
|
||||
- `scope`:可选,业务域/组件名(`lower_snake_case`),用于辅助定位影响范围。
|
||||
- `subject`:一句话概述,使用祈使句/现在时,首字母小写,不加句号。
|
||||
@@ -64,23 +64,23 @@ footer
|
||||
|
||||
本仓库采用固定的 `type`/emoji 一一对应关系;使用 emoji 时必须使用对应的那一个,不得错配。
|
||||
|
||||
| type | emoji(预览 / 代码) | 说明 |
|
||||
| ----------- | --------------------------------- | ---------------------------- |
|
||||
| `init` | :tada: `:tada:` | 初始化/首次发布 |
|
||||
| `feat` | :sparkles: `:sparkles:` | 新功能 |
|
||||
| `fix` | :bug: `:bug:` | Bug 修复 |
|
||||
| `perf` | :rocket: `:rocket:` | 性能优化 |
|
||||
| `refactor` | :recycle: `:recycle:` | 重构(行为不变) |
|
||||
| `style` | :art: `:art:` | 代码样式/格式(行为不变) |
|
||||
| `docs` | :memo: `:memo:` | 文档更新 |
|
||||
| `test` | :white_check_mark: `:white_check_mark:` | 测试新增/修正 |
|
||||
| `deps` | :package: `:package:` | 依赖更新 |
|
||||
| `security` | :lock: `:lock:` | 安全修复 |
|
||||
| `deprecate` | :warning: `:warning:` | 废弃/弃用标记 |
|
||||
| `remove` | :wastebasket: `:wastebasket:` | 删除功能/代码 |
|
||||
| `chore` | :wrench: `:wrench:` | 构建/配置/工具/维护性改动 |
|
||||
| `contrib` | :busts_in_silhouette: `:busts_in_silhouette:` | 贡献者/致谢相关 |
|
||||
| `release` | :bookmark: `:bookmark:` | 发布/打版本标签 |
|
||||
| type | emoji(预览 / 代码) | 说明 |
|
||||
| ----------- | --------------------------------------------- | ------------------------- |
|
||||
| `init` | :tada: `:tada:` | 初始化/首次发布 |
|
||||
| `feat` | :sparkles: `:sparkles:` | 新功能 |
|
||||
| `fix` | :bug: `:bug:` | Bug 修复 |
|
||||
| `perf` | :rocket: `:rocket:` | 性能优化 |
|
||||
| `refactor` | :recycle: `:recycle:` | 重构(行为不变) |
|
||||
| `style` | :art: `:art:` | 代码样式/格式(行为不变) |
|
||||
| `docs` | :memo: `:memo:` | 文档更新 |
|
||||
| `test` | :white_check_mark: `:white_check_mark:` | 测试新增/修正 |
|
||||
| `deps` | :package: `:package:` | 依赖更新 |
|
||||
| `security` | :lock: `:lock:` | 安全修复 |
|
||||
| `deprecate` | :warning: `:warning:` | 废弃/弃用标记 |
|
||||
| `remove` | :wastebasket: `:wastebasket:` | 删除功能/代码 |
|
||||
| `chore` | :wrench: `:wrench:` | 构建/配置/工具/维护性改动 |
|
||||
| `contrib` | :busts_in_silhouette: `:busts_in_silhouette:` | 贡献者/致谢相关 |
|
||||
| `release` | :bookmark: `:bookmark:` | 发布/打版本标签 |
|
||||
|
||||
注:`:white_check_mark:` 为补充图例,用于 `test` 类型。
|
||||
|
||||
@@ -146,7 +146,7 @@ MAJOR.MINOR.PATCH
|
||||
|
||||
带 emoji:
|
||||
|
||||
```
|
||||
```txt
|
||||
:sparkles: feat(order): add batch cancel api
|
||||
|
||||
support canceling multiple orders in one request; keep old api unchanged.
|
||||
@@ -156,6 +156,6 @@ Refs: TSL-1234
|
||||
|
||||
不带 emoji:
|
||||
|
||||
```
|
||||
```txt
|
||||
refactor(order): simplify cancel flow
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user