update contribuer document

79f0a238 · shirenchuang · 1c0fda1a · 79f0a238 · 79f0a238 · 79f0a238
Showing with 10 addition and 160 deletion

README.md README.md +5 -1

docs/contributer_guide/开发者名单.md docs/contributer_guide/开发者名单.md +1 -41

docs/contributer_guide/贡献流程.md docs/contributer_guide/贡献流程.md +4 -118

未找到文件。
--- a/README.md
+++ b/README.md
@@ -99,7 +99,11 @@

 ## 成为社区贡献者

-点击 [这里](CONTRIBUTING.md)，了解如何成为 Know Streaming 的贡献者
+1. [贡献源码](https://doc.knowstreaming.com/product/10-contribution) 了解如何成为 Know Streaming 的贡献者
+2. [具体贡献流程](https://doc.knowstreaming.com/product/10-contribution#102-贡献流程)
+3. [开源激励计划](https://doc.knowstreaming.com/product/10-contribution#105-开源激励计划)
+4. [贡献者名单](https://doc.knowstreaming.com/product/10-contribution#106-贡献者名单)
+

 获取KnowStreaming开源社区证书。


--- a/docs/contributer_guide/开发者名单.md
+++ b/docs/contributer_guide/开发者名单.md
@@ -2,45 +2,5 @@
 开源贡献者证书发放名单(定期更新)


-贡献者名单请看：[贡献者名单]()
-
-
-
-|姓名|Github|角色|发放日期|
-|--|--|--|--|
-|张亮 | [@zhangliangboy](https://github.com/zhangliangboy)|||
-|赵情融 | [@zqrferrari](https://github.com/zqrferrari)|||
-|谢鹏|[@PenceXie](https://github.com/PenceXie)|||
-|孙超|[@lucasun](https://github.com/lucasun)|||
-|许喆 | [@potaaaaaato](https://github.com/potaaaaaato)|||
-|石臻臻 | [@shirenchuang](https://github.com/shirenchuang)|||
-|郭宇航|[@GraceWalk](https://github.com/GraceWalk)|||
-|曾巧|[@ZQKC](https://github.com/ZQKC)|||
-|赵寅锐|[@ZHAOYINRUI](https://github.com/ZHAOYINRUI)|||
-|王东方|[@wangdongfang-aden](https://github.com/wangdongfang-aden)|||
-|haoqi123|[@[haoqi123]](https://github.com/haoqi123)|||
-|17hao|[@17hao](https://github.com/17hao)|||
-|Huyueeer|[@Huyueeer](https://github.com/Huyueeer)|||
-|杨光|[@yaangvipguang](https://github.com/yangvipguang)|
-|王亚聪|[@wangyacongi](https://github.com/wangyacongi)|
-|王耀波|[@WYAOBO](https://github.com/WYAOBO)
-| Super .Wein（星痕）| [@superspeedone](https://github.com/superspeedone)|||
-| Yang Jing| [@yangbajing](https://github.com/yangbajing)|||
-| 刘新元 Liu XinYuan| [@Liu-XinYuan](https://github.com/Liu-XinYuan)|||
-|Joker | [@LiubeyJokerQueue](https://github.com/JokerQueue)|||
-|Eason Lau | [@Liubey](https://github.com/Liubey)|||
-| hailanxin| [@hailanxin](https://github.com/hailanxin)|||
-| Qi Zhang| [@zzzhangqi](https://github.com/zzzhangqi)|||
-|Hongten | [@Hongten](https://github.com/Hongten)|||
-|fengxsong | [@fengxsong](https://github.com/fengxsong)|||
-|f1558 | [@f1558](https://github.com/f1558)|||
-| 谢晓东| [@Strangevy](https://github.com/Strangevy)|||
-| ZhaoXinlong| [@ZhaoXinlong](https://github.com/ZhaoXinlong)|||
-|xuehaipeng | [@xuehaipeng](https://github.com/xuehaipeng)|||
-|孔令续 | [@mrazkong](https://github.com/mrazkong)|||
-|徐正熙 | [@hyper-xx)](https://github.com/hyper-xx)|||
-|pierre xiong | [@pierre94](https://github.com/pierre94)|||
-
-
-
+贡献者名单请看：[贡献者名单](https://doc.knowstreaming.com/product/10-contribution#106-贡献者名单)

--- a/docs/contributer_guide/贡献流程.md
+++ b/docs/contributer_guide/贡献流程.md

-### 贡献流程
-
-[贡献源码细则](./././CONTRIBUTING.md)
-
-#### 1. fork didi/KnowStreaming项目到您的github库
-
-找到你要Fork的项目,例如 [KnowStreaming](https://github.com/didi/KnowStreaming)  ,点击Fork按钮。
-
-![在这里插入图片描述](https://img-blog.csdnimg.cn/ac7bfef9ccde49d587c30e702a615ef5.png)
-
-
-#### 2. 克隆或下载您fork的Nacos代码仓库到您本地
-
-```sh
-
-git clone { your fork knowstreaming repo address }
-
-cd KnowStreaming
-
-```
-
-#### 3. 添加 didi/KnowStreaming仓库为upstream仓库
-
-
-```sh
-
-### 添加源仓库
-git remote add upstream https://github.com/didi/KnowStreaming
-
-### 查看是否添加成功
-git remote -v 
-
-    origin	   ${your fork KnowStreaming repo address} (fetch)
-    origin	   ${your fork KnowStreaming repo address} (push)
-    upstream	https://github.com/didi/KnowStreaming(fetch)
-    upstream	https://github.com/didi/KnowStreaming (push)
-
-### 获取源仓库的基本信息    
-git fetch origin
-git fetch upstream
-
-```
-上面是将didi/KnowStreaming添加为远程仓库, 当前就会有2个远程仓库
-
-1. origin ： 你Fork出来的分叉仓库
-2. upstream ： 源仓库
-
-git fetch 获取远程仓库的基本信息, 比如 **源仓库**的所有分支就获取到了
-
-
-#### 4. 同步源仓库开发分支到本地分叉仓库中
-
-一般开源项目都会有一个给贡献者提交代码的分支，例如 KnowStreaming的分支是 `dev`；
-
-
-首先我们要将 **源仓库**的开发分支(`dev`) 拉取到本地仓库中
-```sh
-
-git checkout -b dev upstream/dev
-```
-**或者IDEA的形式创建**
-
-![在这里插入图片描述](https://img-blog.csdnimg.cn/c95f2601a9af41889a5fc20b2a9724a5.png)
-
-#### 5. 在本地新建的开发分支上进行修改
-
-首先请保证您阅读并正确设置KnowStreaming code style, 相关内容请阅读[KnowStreaming 代码规约 ]()。
-
-修改时请保证该分支上的修改仅和issue相关，并尽量细化，做到
-
-<font color=red><b>一个分支只修改一件事，一个PR只修改一件事</b></font>。
-
-同时，您的提交记录请尽量描述清楚，主要以谓 + 宾进行描述，如：Fix xxx problem/bug。少量简单的提交可以使用For xxx来描述，如：For codestyle。 如果该提交和某个ISSUE相关，可以添加ISSUE号作为前缀，如：For #10000, Fix xxx problem/bug。
-
-
-#### 6. Rebase 基础分支和开发分支
-
-您修改的时候，可能别人的修改已经提交并被合并，此时可能会有冲突，这里请使用rebase命令进行合并解决，主要有2个好处：
-
-1. 您的提交记录将会非常优雅，不会出现Merge xxxx branch 等字样
-2. rebase后您分支的提交日志也是一条单链，基本不会出现各种分支交错的情况，回查时更轻松
-
-```sh
-git fetch upstream
-
-git rebase -i upstream/dev
-
-```
-**或者在IDEA的操作如下**
-
-![在这里插入图片描述](https://img-blog.csdnimg.cn/d75addcfa9564d3d9e1d226a2f7f4d64.png)
-选择 源仓库的开发分支
-![在这里插入图片描述](https://img-blog.csdnimg.cn/4e85714df13b44bcb10f1e655450cb72.png)
-
-推荐使用IDEA的方式, 有冲突的时候更容易解决冲突问题。
-
-#### 7. 将您开发完成rebase后的分支，上传到您fork的仓库
-
-```sh
-git push origin dev
-```
-
-#### 8. 按照PR模板中的清单创建Pull Request
-
-
-
-![在这里插入图片描述](https://img-blog.csdnimg.cn/1dab060aed314666970e3910e05f2205.png)
-
-选择自己的分支合并到模板分支。
-
-
-#### 9. 等待合并代码
-
-提交了PR之后，需要等待PMC、Commiter 来Review代码，如果有问题需要配合修改重新提交。
-
-如果没有问题会直接合并到开发分支`dev`中。
-
-注： 如果长时间没有review, 则可以多催促社区来Review代码！

+<br>
+<br>

+请点击：[贡献流程](https://doc.knowstreaming.com/product/10-contribution#102-贡献流程)
\ No newline at end of file