diff --git "a/docs/contribute_guide/\350\264\241\347\214\256\346\214\207\345\215\227.md" "b/docs/contribute_guide/\350\264\241\347\214\256\346\214\207\345\215\227.md" index 37cf89bc132f51f238b4661e503a0ea9f8be8a2e..8ea7c5516dd0a835faa584ab1da9ffd518c59aae 100644 --- "a/docs/contribute_guide/\350\264\241\347\214\256\346\214\207\345\215\227.md" +++ "b/docs/contribute_guide/\350\264\241\347\214\256\346\214\207\345\215\227.md" @@ -47,14 +47,13 @@ **1、`Header` 规范** -`Header` 格式为 `[Type]Message(#IssueID)`, 主要有三部分组成,分别是`Type`、`Message`、`IssueID`, +`Header` 格式为 `[Type]Message`, 主要有三部分组成,分别是`Type`、`Message`, - `Type`:说明这个提交是哪一个类型的,比如有 Bugfix、Feature、Optimize等; - `Message`:说明提交的信息,比如修复xx问题; -- `IssueID`:该提交,关联的Issue的编号; -实际例子:[`[Bugfix]修复新接入的集群,Controller-Host不显示的问题(#927)`](https://github.com/didi/KnowStreaming/pull/933/commits) +实际例子:[`[Bugfix]修复新接入的集群,Controller-Host不显示的问题`](https://github.com/didi/KnowStreaming/pull/933/commits) @@ -67,7 +66,7 @@ **3、实际例子** ``` -[Optimize]优化 MySQL & ES 测试容器的初始化(#906) +[Optimize]优化 MySQL & ES 测试容器的初始化 主要的变更 1、knowstreaming/knowstreaming-manager 容器; @@ -138,7 +137,7 @@ 1. 切换到主分支:`git checkout github_master`; 2. 主分支拉最新代码:`git pull`; 3. 基于主分支拉新分支:`git checkout -b fix_928`; -4. 提交代码,安装commit的规范进行提交,例如:`git commit -m "[Optimize]优化xxx问题(#928)"`; +4. 提交代码,安装commit的规范进行提交,例如:`git commit -m "[Optimize]优化xxx问题"`; 5. 提交到自己远端仓库:`git push --set-upstream origin fix_928`; 6. `GitHub` 页面发起 `Pull Request` 请求,管理员合入主仓库。这部分详细见下一节; @@ -162,6 +161,8 @@ ### 4.1、如何将多个 Commit-Log 合并为一个? -可以使用 `git rebase -i` 命令进行解决。 +可以不需要将多个commit合并为一个,如果要合并,可以使用 `git rebase -i` 命令进行解决。 + +