File tree Expand file tree Collapse file tree 1 file changed +6
-5
lines changed Expand file tree Collapse file tree 1 file changed +6
-5
lines changed Original file line number Diff line number Diff line change 1
1
# 代码贡献指南
2
- 1 . 非常欢迎和感谢对本项目发起Pull Request的同学,本项目代码风格为使用2个空格代表一个Tab,因此在提交代码时请注意一下,否则很容易在IDE格式化代码后与原代码产生大量diff,这样会给其他人阅读代码带来极大的困扰。为了便于设置,本项目引入editorconfig插件,请使用eclipse的同学在贡献代码前安装相关插件,IntelliJ IDEA新版本自带支持,如果没有可自行安装插件。
2
+ 1 . 首先非常欢迎和感谢对本项目发起Pull Request的同学。
3
+ 1 . 本项目代码风格为使用2个空格代表一个Tab,因此在提交代码时请注意一下,否则很容易在IDE格式化代码后与原代码产生大量diff,这样会给其他人阅读代码带来极大的困扰。
4
+ 1 . 为了便于设置,本项目引入editorconfig支持,请使用Eclipse的同学在贡献代码前安装相关插件,而IntelliJ IDEA新版本自带支持,如果没有可自行安装插件。
5
+ 1 . ** 提交代码前,请检查代码是否已经格式化,并且保证新增加或者修改的方法都有完整的参数说明,而public方法必须拥有相应的单元测试并通过测试。**
3
6
1 . 本项目可以采用两种方式接受代码贡献:
4
- * 第一种就是基于[ Git Flow] ( https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow ) 开发流程,因此在发起Pull Request的时候请选择develop分支,详细步骤参考后文,推荐使用此种方式贡献代码。
5
- * (*** 暂停此种方式,请使用第一种*** )另外一种贡献代码的方式就是加入SDK Developers开发组,前提是对自己的代码足够自信就可以申请加入,加入之后可以随时直接提交代码,但要注意对所做的修改或新增的代码进行单元测试,保证提交代码没有明显问题。
6
- 1 . 另外,提交代码前请检查代码是否已经格式化,并且保证新增加或者修改的方法都有完整的参数说明,而public方法必须拥有相应的单元测试并通过测试。
7
-
7
+ - 第一种就是基于[ Git Flow] ( https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow ) 开发流程,因此在发起Pull Request的时候请选择develop分支,详细步骤参考后文,推荐使用此种方式贡献代码。
8
+ - (*** 暂停此种方式,请使用第一种*** )另外一种贡献代码的方式就是加入SDK Developers开发组,前提是对自己的代码足够自信就可以申请加入,加入之后可以随时直接提交代码,但要注意对所做的修改或新增的代码进行单元测试,保证提交代码没有明显问题。
8
9
9
10
### PR方式贡献代码步骤
10
11
* 在 GitHub 上 ` fork ` 到自己的仓库,如 ` my_user/weixin-java-tools ` ,然后 ` clone ` 到本地,并设置用户信息。
You can’t perform that action at this time.
0 commit comments