dolphinscheduler-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lidong...@apache.org
Subject [incubator-dolphinscheduler-website] branch master updated: update document add contribute
Date Mon, 02 Dec 2019 15:49:40 GMT
This is an automated email from the ASF dual-hosted git repository.

lidongdai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-dolphinscheduler-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 6f00db5  update document add contribute
     new 27f876e  Merge pull request #44 from dailidong/master
6f00db5 is described below

commit 6f00db54a7b0b40178bea8d6ee2ff9fa1158f847
Author: dailidong <dailidong66@gmail.com>
AuthorDate: Mon Dec 2 23:46:21 2019 +0800

    update document add contribute
---
 docs/en-us/development/submit-code.md |  3 ++
 docs/zh-cn/development/contribute.md  | 70 +----------------------------------
 docs/zh-cn/development/submit-code.md | 67 +++++++++++++++++++++++++++++++++
 md_json/docs.json                     | 10 +++++
 site_config/development.js            | 33 +++++++++++------
 5 files changed, 103 insertions(+), 80 deletions(-)

diff --git a/docs/en-us/development/submit-code.md b/docs/en-us/development/submit-code.md
new file mode 100644
index 0000000..7b6c37a
--- /dev/null
+++ b/docs/en-us/development/submit-code.md
@@ -0,0 +1,3 @@
+#### how to submit code
+
+TODO
diff --git a/docs/zh-cn/development/contribute.md b/docs/zh-cn/development/contribute.md
index 9493bce..5db73df 100644
--- a/docs/zh-cn/development/contribute.md
+++ b/docs/zh-cn/development/contribute.md
@@ -90,73 +90,7 @@ Priority分为四级: Critical、Major、Minor、Trivial
 * 如果想要开发实现某个Feature功能,请先回复该功能所关联的Issue,表明您当前正在这个Issue上工作。
并在回复的时候为自己设置一个deadline,并添加的回复内容中。
 * 最好在核心贡献者找到一个导师(指导者),导师会在设计与功能实现上给予即时的反馈。
 * 您应该新建一个分支来开始您的工作,分支的名字为Feature功能名称/issueId。
比如,您想完成依赖功能并提交了Issue 111,那么您的branch名字应为 dependency/111。
功能名称可与导师讨论后确定。
-* 完成后,发送一个pull request到incubator-dolphinscheduler,提交过程具体请参考下面《如何提交代码》。
+* 完成后,发送一个pull request到incubator-dolphinscheduler,提交过程具体请参考下面《提交代码》。
 
+如果是想提交Pull Request完成某一个Feature或者修复某个Bug,这里都建议大家从小处做起,完成一个小功能就提交一次,每次别改动太多文件(最好6个以下),改动文件太多也会给Reviewer造成很大的心里压力,建议通过多次pr的方式完成。
 
-### 4. 如何提交代码
-
-* 首先从远端仓库*https://github.com/apache/incubator-dolphinscheduler.git* fork一份代码到自己的仓库中
-
-* 远端仓库中目前有三个分支:
-    * master 正常交付分支
-	   发布稳定版本以后,将稳定版本分支的代码合并到master上。
-    
-	* dev    日常开发分支
-	   日常dev开发分支,新提交的代码都可以pull request到这个分支上。
-	   
-    * branch-1.0.0 发布版本分支
-	   发布版本分支,后续会有2.0...等版本分支,版本分支只修改bug,不增加新功能。
-
-* 把自己仓库clone到本地
-  
-    ` git clone https://github.com/apache/incubator-dolphinscheduler.git`
-
-*  添加远端仓库地址,命名为upstream
-
-    ` git remote add upstream https://github.com/apache/incubator-dolphinscheduler.git `
-
-*  查看仓库:
-
-    ` git remote -v`
-
-> 此时会有两个仓库:origin(自己的仓库)和upstream(远端仓库)
-
-*  获取/更新远端仓库代码(已经是最新代码,就跳过)
-  
-    ` git fetch upstream `
-
-
-* 同步远端仓库代码到本地仓库
-
-```
- git checkout origin/dev
- git merge --no-ff upstream/dev
-```
-
-如果远端分支有新加的分支比如`dev-1.0`,需要同步这个分支到本地仓库
-
-```
-git checkout -b dev-1.0 upstream/dev-1.0
-git push --set-upstream origin dev1.0
-```
-
-* 在本地修改代码以后,提交到自己仓库:
-  
-    `git commit -m 'commit content'`
-    `git push`
-
-* 将修改提交到远端仓库
-
-	* 在github页面,点击New pull request.
-		<p align="center">
-	   <img src="http://geek.analysys.cn/static/upload/221/2019-04-02/90f3abbf-70ef-4334-b8d6-9014c9cf4c7f.png"
width="60%" />
-	 </p>
-	 
-	* 选择修改完的本地分支和要合并过去的分支,Create pull request.
-		<p align="center">
-	   <img src="http://geek.analysys.cn/static/upload/221/2019-04-02/fe7eecfe-2720-4736-951b-b3387cf1ae41.png"
width="60%" />
-	 </p>
-	
-* 接着社区Committer们会做CodeReview,然后他会与您讨论一些细节(包括设计,实现,性能等)。当团队中所有人员对本次修改满意后,会将提交合并到dev分支
-
-* 最后,恭喜您已经成为了dolphinscheduler的官方贡献者!
diff --git a/docs/zh-cn/development/submit-code.md b/docs/zh-cn/development/submit-code.md
new file mode 100644
index 0000000..52231a3
--- /dev/null
+++ b/docs/zh-cn/development/submit-code.md
@@ -0,0 +1,67 @@
+#### 提交代码流程
+
+* 首先从远端仓库*https://github.com/apache/incubator-dolphinscheduler.git* fork一份代码到自己的仓库中
+
+* 远端仓库中目前有三个分支:
+    * master 正常交付分支
+	   发布稳定版本以后,将稳定版本分支的代码合并到master上。
+    
+	* dev    日常开发分支
+	   日常dev开发分支,新提交的代码都可以pull request到这个分支上。
+	   
+    * branch-1.0.0 发布版本分支
+	   发布版本分支,后续会有2.0...等版本分支,版本分支只修改bug,不增加新功能。
+
+* 把自己仓库clone到本地
+  
+    ` git clone https://github.com/apache/incubator-dolphinscheduler.git`
+
+*  添加远端仓库地址,命名为upstream
+
+    ` git remote add upstream https://github.com/apache/incubator-dolphinscheduler.git `
+
+*  查看仓库:
+
+    ` git remote -v`
+
+> 此时会有两个仓库:origin(自己的仓库)和upstream(远端仓库)
+
+*  获取/更新远端仓库代码(已经是最新代码,就跳过)
+  
+    ` git fetch upstream `
+
+
+* 同步远端仓库代码到本地仓库
+
+```
+ git checkout origin/dev
+ git merge --no-ff upstream/dev
+```
+
+如果远端分支有新加的分支比如`dev-1.0`,需要同步这个分支到本地仓库
+
+```
+git checkout -b dev-1.0 upstream/dev-1.0
+git push --set-upstream origin dev1.0
+```
+
+* 在本地修改代码以后,提交到自己仓库:
+  
+    `git commit -m 'commit content'`
+    `git push`
+
+* 将修改提交到远端仓库
+
+	* 在github页面,点击New pull request.
+		<p align="center">
+	   <img src="http://geek.analysys.cn/static/upload/221/2019-04-02/90f3abbf-70ef-4334-b8d6-9014c9cf4c7f.png"
width="60%" />
+	 </p>
+	 
+	* 选择修改完的本地分支和要合并过去的分支,Create pull request.
+		<p align="center">
+	   <img src="http://geek.analysys.cn/static/upload/221/2019-04-02/fe7eecfe-2720-4736-951b-b3387cf1ae41.png"
width="60%" />
+	 </p>
+	
+* 接着社区Committer们会做CodeReview,然后他会与您讨论一些细节(包括设计,实现,性能等)。当团队中所有人员对本次修改满意后,会将提交合并到dev分支
+
+* 最后,恭喜您已经成为了dolphinscheduler的官方贡献者!
diff --git a/md_json/docs.json b/md_json/docs.json
index c60c7eb..ae529a2 100755
--- a/md_json/docs.json
+++ b/md_json/docs.json
@@ -6,6 +6,11 @@
       "meta": {}
     },
     {
+      "filename": "submit-code.md",
+      "link": "/en-us/docs/development/submit-code.html",
+      "meta": {}
+    },
+    {
       "filename": "architecture-design.md",
       "link": "/en-us/docs/development/architecture-design.html",
       "meta": {}
@@ -78,6 +83,11 @@
       "meta": {}
     },
     {
+      "filename": "submit-code.md",
+      "link": "/zh-cn/docs/development/submit-code.html",
+      "meta": {}
+    },
+    {
       "filename": "architecture-design.md",
       "link": "/zh-cn/docs/development/architecture-design.html",
       "meta": {}
diff --git a/site_config/development.js b/site_config/development.js
index 66ab423..e60d32d 100755
--- a/site_config/development.js
+++ b/site_config/development.js
@@ -5,6 +5,20 @@ export default {
                 title: 'Developer guide',
                 children: [
                     {
+                        title: 'Contribution Guide',
+                        children: [
+                            {
+                                title: 'Subscribe mail list',
+                                target: '_blank',
+                                link: '/en-us/docs/user_doc/subscribe.html',
+                            },
+                            {
+                                title: 'Participate in contributing',
+                                link: '/en-us/docs/development/contribute.html',
+                            }
+                        ],
+                    },
+                    {
                         title: 'Architecture Design',
                         link: '/en-us/docs/development/architecture-design.html',
                     },
@@ -23,11 +37,11 @@ export default {
                 ],
             },
             {
-                title: 'Committer Guide',
+                title: 'Submit Guide',
                 children: [
                     {
-                        title: 'Contribute',
-                        link: '/en-us/docs/development/contribute.html',
+                        title: 'Submit Pull Request Process',
+                        link: '/en-us/docs/development/submit-code.html',
                     },
                     {
                         title: 'Developers',
@@ -66,17 +80,12 @@ export default {
                         link: '/zh-cn/docs/development/backend-development.html',
                     },
                     {
-                        title: '插件开发',
-                        link: '/zh-cn/docs/development/plugin-development.html',
-                    },
-                    {
                         title: '前端开发',
                         link: '/zh-cn/docs/development/frontend-development.html',
                     },
                     {
-                        title: '接口文档',
-                        target: '_blank',
-                        link: 'http://106.75.43.194:8888/easyscheduler/doc.html?language=zh_CN&lang=zh'
+                        title: '插件开发',
+                        link: '/zh-cn/docs/development/plugin-development.html',
                     },
                 ],
             },
@@ -84,8 +93,8 @@ export default {
                 title: '提交者向导',
                 children: [
                     {
-                        title: '参与贡献',
-                        link: '/zh-cn/docs/development/contribute.html',
+                        title: '提交流程',
+                        link: '/zh-cn/docs/development/submit-code.html',
                     },
                     {
                         title: '开发人员',


Mime
View raw message