chore:Migrate "项目规范" contents to spec.md
This commit is contained in:
12
README.md
12
README.md
@ -30,17 +30,7 @@ TODO
|
|||||||
|
|
||||||
## 三、项目规范
|
## 三、项目规范
|
||||||
|
|
||||||
为规范开发流程,我们制定了以下几条规则:
|
请参阅[项目规范](./Docs/spec.md)文档。
|
||||||
|
|
||||||
1. 提交更改时,评论文本格式应为`(PART) COMMENT`。
|
|
||||||
- `PART`表明更改部分,如`client`(表明更改的是客户端部分)和`tools`(表明更改的是工具部分)等。
|
|
||||||
- `COMMENT`表明更改详情,用简练的语言描述更改内容。
|
|
||||||
- 如果提交性质符合以下几种,则评论格式如下:
|
|
||||||
- 功能添加:`feat:xxx`
|
|
||||||
- 漏洞修复:`fix:xxx`
|
|
||||||
- 日常维护:`chore:xxx`
|
|
||||||
2. 请确保你的提交为原子提交(即不可再分割成数个部分的提交),以便项目维护。
|
|
||||||
3. 除策划案等此类文档(一般这类文档使用 Word 撰写),其他类型文档请使用 Markdown 撰写。
|
|
||||||
|
|
||||||
## 四、工具及其版本
|
## 四、工具及其版本
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user