diff --git a/README.md b/README.md index 6863e4f..7971e2e 100644 --- a/README.md +++ b/README.md @@ -89,3 +89,28 @@ TODO: 待补充具体标签 请尽量清晰的表达出你们的具体任务 +# 2. commit 规范 + +1. commit message格式 + + `: (#n)` + + 注意:符号为英文符号 冒号后面有空格 n为issue的编号 + + 例: `fix: solve subrouter invalid problem (#15)` + + +2. type 用于说明 commit 的类别,只允许使用下面7个标识 + + feat:新功能(feature) + fix:修补bug + docs:文档(documentation) + style:格式(不影响代码运行的变动) + refactor:重构(即不是新增功能,也不是修改bug的代码变动) + test:增加测试 + chore:构建过程或辅助工具的变动 + + +3. subject + + 是commit代码的简短描述,末尾不加标点符号