diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 00000000..54c039d4 --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,72 @@ +# 代码贡献指南 + +## 一、操作流程 + + ![代码贡献操作流程](images/contribute.png) + +## 二、代码格式 + +dbswitch使用java编码开发，这里以IDEA为例，指定使用google的代码风格，可将项目下的intellij-java-google-style.xml文件导入到IDEA中。 + + ![code style](images/code_style.png) + +## 二、操作步骤 + +### 1、Fork 本项目 + +首先使用gitee账号（如果没有请先注册）登陆后，然后进入地址```https://gitee.com/inrgihc/dbswitch```中，点击```fork```按钮，在自己账号下复制一份dbswitch项目，如下图： + + ![Fork dbswitch](images/git_fork.png) + +### 2、Clone 自己的项目 + +- (1) 拉取远端的代码到本地 +``` +git clone -b dev https://gitee.com/tangyibo/dbswitch.git +cd dbswitch/ +``` +- (2) 请正确配置自己的信息(此信息会包含在后面的commit提交信息中) +``` +git config --local user.name xxxx +git config --local user.email xxxx@126.com +``` +**注：请替换上述中的xxxx为实际的信息** +- (3) 配置远端dbswitch项目的名称(这里假设为upstream) +``` +git remote add upstream https://gitee.com/inrgihc/dbswitch.git +``` + +### 2、commit & push到自己的分支 + +- (1) 在本地向自己的分支中提交代码: + +- (2) fetch 远端dbswitch的最新代码 +``` +git fetch upstream master +``` + +- (3) rebase 远端dbswitch的最新代码(处理可能存在的冲突) +``` +git rebase upstream/master +``` + +- (4) push 本地代码到远端 +``` +git push +``` + +- (5) 查看远端的commit信息 + + ![push dbswitch](images/git_push.png) + +### 3、创建 pull requests + +在自己的分支上创建pull requests: + + ![PR dbswitch](images/git_pr.png) + +选择对应的分支： + + ![PR dbswitch](images/git_select.png) + +填写好“标题”和“描述”，点击“创建Pull Request"即可完成代码提交合入申请操作，审核通过后您成为dbswitch项目贡献者。 diff --git a/README.md b/README.md index baa51b15..42ac9134 100644 --- a/README.md +++ b/README.md @@ -560,7 +560,11 @@ service.run(); （5）https://blog.csdn.net/inrgihc/article/details/121447417 -## 七、问题反馈 +## 七、贡献参与 + +为了能让项目得到更好的可持续的发展，dbswitch期望获得更多的代码开发爱好者参与代码贡献，具体可参见文档说明：[贡献说明指南](/CONTRIBUTE.md) + +## 八、问题反馈 如果您看到并使用了本工具，或您觉得本工具对您有价值，请为此项目**点个赞**，以表示对本项目的支持，多谢！如果您在使用时遇到了bug，欢迎在issue中反馈。也可扫描下方二维码入群讨论：（加好友请注明："程序交流"） diff --git a/images/code_style.png b/images/code_style.png new file mode 100644 index 00000000..6001935c Binary files /dev/null and b/images/code_style.png differ diff --git a/images/contribute.png b/images/contribute.png new file mode 100644 index 00000000..df9848bd Binary files /dev/null and b/images/contribute.png differ diff --git a/images/git_fork.png b/images/git_fork.png new file mode 100644 index 00000000..b5adfbf1 Binary files /dev/null and b/images/git_fork.png differ diff --git a/images/git_pr.png b/images/git_pr.png new file mode 100644 index 00000000..4716ec01 Binary files /dev/null and b/images/git_pr.png differ diff --git a/images/git_push.png b/images/git_push.png new file mode 100644 index 00000000..04186537 Binary files /dev/null and b/images/git_push.png differ diff --git a/images/git_select.png b/images/git_select.png new file mode 100644 index 00000000..66379a26 Binary files /dev/null and b/images/git_select.png differ diff --git a/intellij-java-google-style.xml b/intellij-java-google-style.xml new file mode 100644 index 00000000..f3a6743e --- /dev/null +++ b/intellij-java-google-style.xml @@ -0,0 +1,598 @@ + + + + + +