mirror of
https://gitee.com/binary/weixin-java-tools.git
synced 2025-04-30 12:47:46 +08:00
37 lines
2.3 KiB
Markdown
37 lines
2.3 KiB
Markdown
# 代码贡献指南
|
||
1. 首先非常欢迎和感谢对本项目发起 `Pull Request` 的热心小伙伴们。
|
||
1. **特别提示：请务必在 `develop` 分支提交 `PR`，`release` 分支目前仅是正式版的代码，即发布正式版本后才会从 `develop` 分支进行合并。**
|
||
1. 本项目代码风格为使用2个空格代表一个Tab，因此在提交代码时请注意一下，否则很容易在IDE格式化代码后与原代码产生大量diff，这样会给其他人阅读代码带来极大的困扰。
|
||
1. 为了便于设置，本项目引入`editorconfig`支持，请使用Eclipse的同学在贡献代码前安装相关插件，而`IntelliJ IDEA`新版本自带支持，如果没有可自行安装插件。
|
||
1. **提交代码前，请检查代码是否已经格式化，并且保证新增加或者修改的方法都有完整的参数说明，而public方法必须拥有相应的单元测试并通过测试。**
|
||
1. 本项目可以采用两种方式接受代码贡献：
|
||
- 第一种就是基于[Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)开发流程，因此在发起Pull Request的时候请选择develop分支，详细步骤参考后文，推荐使用此种方式贡献代码。
|
||
- （***暂停此种方式，请使用第一种***）另外一种贡献代码的方式就是加入SDK Developers开发组，前提是对自己的代码足够自信就可以申请加入，加入之后可以随时直接提交代码，但要注意对所做的修改或新增的代码进行单元测试，保证提交代码没有明显问题。
|
||
|
||
### PR方式贡献代码步骤
|
||
* 在 GitHub 上 `fork` 到自己的仓库，如 `my_user/WxJava`，然后 `clone` 到本地，并设置用户信息。
|
||
|
||
```bash
|
||
$ git clone git@github.com:{your-github-username}/WxJava.git
|
||
$ cd WxJava
|
||
$ git config user.name "yourname"
|
||
$ git config user.email "your email"
|
||
```
|
||
* 修改代码后提交，并推送到自己的仓库。
|
||
|
||
```bash
|
||
$ #do some change on the content
|
||
$ git commit -am "Fix issue #1: change something"
|
||
$ git push
|
||
```
|
||
* 在 `GitHub` 或 `Gitee` 网站上提交 `Pull Request`。
|
||
* 定期使用项目仓库内容更新自己仓库内容。
|
||
|
||
```bash
|
||
$ git remote add upstream https://github.com/Wechat-Group/WxJava
|
||
$ git fetch upstream
|
||
$ git checkout develop
|
||
$ git rebase upstream/develop
|
||
$ git push -f origin develop
|
||
```
|