From a1a5d7ceada42ebe434f7ac4493cf24b252bb885 Mon Sep 17 00:00:00 2001 From: Binary Wang Date: Fri, 30 Dec 2016 23:18:47 +0800 Subject: [PATCH 1/7] Update README.md --- README.md | 32 -------------------------------- 1 file changed, 32 deletions(-) diff --git a/README.md b/README.md index e9f489de..d0d93026 100644 --- a/README.md +++ b/README.md @@ -78,35 +78,3 @@ compile 'com.github.binarywang:weixin-java-cp:2.4.0' 1. https://github.com/wechat-group/weixin-java-mp-multi-demo (支持多公众号) 1. https://github.com/wechat-group/weixin-java-tools-springmvc 1. https://github.com/wechat-group/weixin-java-mp-demo-springboot - - -=========== -## 关于代码贡献 -1. 非常欢迎和感谢对本项目发起Pull Request的同学,本项目代码风格为使用2个空格代表一个Tab,因此在提交代码时请注意一下,否则很容易在IDE格式化代码后与原代码产生大量diff,这样会给其他人阅读代码带来极大的困扰。为了便于设置,本项目引入editorconfig插件,请使用eclipse的同学在贡献代码前安装相关插件,IntelliJ IDEA新版本自带支持,如果没有可自行安装插件。 -1. 本项目可以采用两种方式接受代码贡献: - * 第一种就是基于[Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)开发流程,因此在发起Pull Request的时候请选择develop分支,详细步骤参考后文。 - * 另外一种贡献代码的方式就是加入SDK Developers开发组,前提是对自己的代码足够自信就可以申请加入,加入之后可以随时直接提交代码,但要注意对所做的修改或新增的代码进行单元测试,保证提交代码没有明显问题,具体加入方式,请咨询QQ群管理员[![点击这里给我发消息](http://wpa.qq.com/pa?p=2:1211415707:51)](http://wpa.qq.com/msgrd?v=3&uin=1211415707&site=qq&menu=yes)。 - -## PR方式贡献代码步骤 -* 在 GitHub 上 `fork` 到自己的仓库,如 `my_user/weixin-java-tools`,然后 `clone` 到本地,并设置用户信息。 -```bash - $ git clone git@github.com:my_user/weixin-java-tools.git - $ cd weixin-java-tools - $ 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 网站上提交 Pull Request。 -* 定期使用项目仓库内容更新自己仓库内容。 -```bash -$ git remote add upstream https://github.com/wechat-group/weixin-java-tools -$ git fetch upstream -$ git checkout develop -$ git rebase upstream/develop -$ git push -f origin develop -``` From 937d03e4e527ded0bcf91e4ebbeff006a7cc260c Mon Sep 17 00:00:00 2001 From: Binary Wang Date: Fri, 30 Dec 2016 23:24:36 +0800 Subject: [PATCH 2/7] Create CONTRIBUTION.md --- CONTRIBUTION.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTION.md diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 00000000..991f5b3e --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,30 @@ +# 关于代码贡献 +1. 非常欢迎和感谢对本项目发起Pull Request的同学,本项目代码风格为使用2个空格代表一个Tab,因此在提交代码时请注意一下,否则很容易在IDE格式化代码后与原代码产生大量diff,这样会给其他人阅读代码带来极大的困扰。为了便于设置,本项目引入editorconfig插件,请使用eclipse的同学在贡献代码前安装相关插件,IntelliJ IDEA新版本自带支持,如果没有可自行安装插件。 +1. 本项目可以采用两种方式接受代码贡献: + * 第一种就是基于[Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)开发流程,因此在发起Pull Request的时候请选择develop分支,详细步骤参考后文。 + * 另外一种贡献代码的方式就是加入SDK Developers开发组,前提是对自己的代码足够自信就可以申请加入,加入之后可以随时直接提交代码,但要注意对所做的修改或新增的代码进行单元测试,保证提交代码没有明显问题,具体加入方式,请咨询QQ群管理员[![点击这里给我发消息](http://wpa.qq.com/pa?p=2:1211415707:51)](http://wpa.qq.com/msgrd?v=3&uin=1211415707&site=qq&menu=yes)。 + + +### PR方式贡献代码步骤 +* 在 GitHub 上 `fork` 到自己的仓库,如 `my_user/weixin-java-tools`,然后 `clone` 到本地,并设置用户信息。 +```bash + $ git clone git@github.com:my_user/weixin-java-tools.git + $ cd weixin-java-tools + $ 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 网站上提交 Pull Request。 +* 定期使用项目仓库内容更新自己仓库内容。 +```bash +$ git remote add upstream https://github.com/wechat-group/weixin-java-tools +$ git fetch upstream +$ git checkout develop +$ git rebase upstream/develop +$ git push -f origin develop +``` From 06a2db97a9583bc0c1a9d405a577cb77bcec192c Mon Sep 17 00:00:00 2001 From: Binary Wang Date: Fri, 30 Dec 2016 23:31:23 +0800 Subject: [PATCH 3/7] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d0d93026..ad2d23ca 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ Weixin Java Tools 微信公众号/企业号开发Java SDK 1. 微信公众号官方文档入口地址:http://mp.weixin.qq.com/wiki (注意,从网上搜到的文档有的虽然地址前面跟这个一样,但明显左侧菜单不一致,是旧的文档,注意不要看错文档)。 1. 各个模块的Javadoc可以在线查看:[weixin-java-mp](https://binarywang.github.io/weixin-java-mp-javadoc/)、[weixin-java-common](https://binarywang.github.io/weixin-java-common-javadoc/)、[weixin-java-cp](https://binarywang.github.io/weixin-java-cp-javadoc/) 1. 本SDK要求的最低JDK版本是7,为满足少量还在使用JDK6的用户的需求,特意抽出独立的代码分支项目,请参考 https://github.com/binarywang/weixin-java-tools-for-jdk6 ,其他更早的JDK版本则需要自己改造实现。 +1. 如果想贡献代码,请阅读[贡献代码指南](CONTRIBUTION.md)。 =========== From 0342514560b20fbd4acd399359cdea5ae2db3e9f Mon Sep 17 00:00:00 2001 From: Binary Wang Date: Fri, 30 Dec 2016 23:39:55 +0800 Subject: [PATCH 4/7] Update README.md --- README.md | 55 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index ad2d23ca..3500d7ee 100644 --- a/README.md +++ b/README.md @@ -3,34 +3,51 @@ Weixin Java Tools 微信公众号/企业号开发Java SDK [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.binarywang/weixin-java-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.binarywang/weixin-java-parent) [![Build Status](https://travis-ci.org/Wechat-Group/weixin-java-tools.svg?branch=develop)](https://travis-ci.org/Wechat-Group/weixin-java-tools) -### 注意: -1. ***本项目Fork自chanjarster/weixin-java-tools,但由于原项目已停止维护,故单独维护和发布,且发布到maven上的groupId也会不同,详细信息见下文。*** -1. ***自2.0.0版本以来,公众号的接口调整比较大,主要是为了解决主接口类过于庞大不方便管理的问题,将接口实现代码按模块进行拆分。*** +### 注意事项: +1. 声明: ***本项目Fork自chanjarster/weixin-java-tools,但由于原项目已停止维护,故单独维护和发布,且发布到maven上的groupId也会不同,详细信息见下文。*** 1. 最新更新:2016-11-30 发布2.4.0正式版! +1. 自2.0.0版本以来,公众号的接口调整比较大,主要是为了解决主接口类过于庞大不方便管理的问题,将接口实现代码按模块进行拆分。 +1. 详细开发文档请看 [Wiki](https://github.com/wechat-group/weixin-java-tools/wiki),部分文档可能未能及时更新,如有发现,可以及时上报或者自行修改。 +1. 微信公众号官方文档入口地址:http://mp.weixin.qq.com/wiki (注意,从网上搜到的文档有的虽然地址前面跟这个一样,但明显左侧菜单不一致,是旧的文档,注意不要看错文档)。 +1. 各个模块的Javadoc可以在线查看:[weixin-java-mp](https://binarywang.github.io/weixin-java-mp-javadoc/)、[weixin-java-common](https://binarywang.github.io/weixin-java-common-javadoc/)、[weixin-java-cp](https://binarywang.github.io/weixin-java-cp-javadoc/) +1. 本SDK要求的最低JDK版本是7,为满足少量还在使用JDK6的用户的需求,特意抽出独立的代码分支项目,请参考 https://github.com/binarywang/weixin-java-tools-for-jdk6 ,其他更早的JDK版本则需要自己改造实现。 +1. 有新功能需求,发现BUG,或者由于微信官方接口调整导致的代码问题,可以直接在[Issues](https://github.com/Wechat-Group/weixin-java-tools/issues)页提出issue,便于讨论追踪问题; +1. 如果想贡献代码,请阅读[贡献代码指南](CONTRIBUTION.md)。 =========== -## 开发交流方式及注意事项: +## SDK使用交流方式说明: 1. QQ群:343954419(推荐点击按钮入群: [![Join QQ Group](http://pub.idqqimg.com/wpa/images/group.png)](http://shang.qq.com/wpa/qunwpa?idkey=731dc3e7ea31ebe25376cc1a791445468612c63fd0e9e05399b088ec81fd9e15) 或 [![Join QQ Group](http://pub.idqqimg.com/wpa/images/group.png)](http://jq.qq.com/?_wv=1027&k=40lRskK),如果无反应,可以自行搜索群号进行添加 ) 1. 由于群容量有限,即将爆满,故开启付费入群模式以保证只有真实交流需求的人进入,并为保证群的活跃度,将不定期清理长时间不活跃的同学; 1. 微信群: 因微信群已达到100人限制,故如有想加入微信群的,请入QQ群后联系管理员,提供微信号以便邀请加入; 1. 新手提问前,请先阅读此文章:http://t.cn/RV93MRB 1. 寻求帮助时需贴代码或大长串异常信息的,请利用http://paste.ubuntu.com -1. 有功能需求或由于微信官方接口调整导致的代码问题,可以直接提出issue,便于讨论追踪问题; -1. 详细开发文档请看 [Wiki](https://github.com/wechat-group/weixin-java-tools/wiki),部分文档可能未能及时更新,如有发现,可以及时上报或者自行修改。 -1. 微信公众号官方文档入口地址:http://mp.weixin.qq.com/wiki (注意,从网上搜到的文档有的虽然地址前面跟这个一样,但明显左侧菜单不一致,是旧的文档,注意不要看错文档)。 -1. 各个模块的Javadoc可以在线查看:[weixin-java-mp](https://binarywang.github.io/weixin-java-mp-javadoc/)、[weixin-java-common](https://binarywang.github.io/weixin-java-common-javadoc/)、[weixin-java-cp](https://binarywang.github.io/weixin-java-cp-javadoc/) -1. 本SDK要求的最低JDK版本是7,为满足少量还在使用JDK6的用户的需求,特意抽出独立的代码分支项目,请参考 https://github.com/binarywang/weixin-java-tools-for-jdk6 ,其他更早的JDK版本则需要自己改造实现。 -1. 如果想贡献代码,请阅读[贡献代码指南](CONTRIBUTION.md)。 =========== ## 版本说明 -1. 本项目定为每两个月发布一次正式版,版本号格式为X.X.0(如2.1.0,2.2.0等),月底发布新版本,遇到重大问题需修复会及时提交新版本,欢迎大家随时提交Pull Request; +1. 本项目定为大约每两个月发布一次正式版,版本号格式为X.X.0(如2.1.0,2.2.0等),遇到重大问题需修复会及时提交新版本,欢迎大家随时提交Pull Request; 1. BUG修复和新特性一般会先发布成小版本作为临时测试版本(如2.4.5.BETA,2.4.6.BETA等,即尾号不为0,并添加BETA字样,以区别于正式版); 1. 目前最新版本号为 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.binarywang/weixin-java-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.binarywang/weixin-java-parent) ,也可以通过访问链接 [【公众号】](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.github.binarywang%22%20AND%20a%3A%22weixin-java-mp%22) 、[【企业号】](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.github.binarywang%22%20AND%20a%3A%22weixin-java-cp%22) 分别查看所有最新的版本。 +=========== + +#### 本项目主要存放在github上,地址为 : +* https://github.com/wechat-group/weixin-java-tools +* ===========但同时会在其他几个网站同步更新,地址分别是: +* https://bitbucket.org/binarywang/weixin-java-tools +* http://git.oschina.net/binary/weixin-java-tools +* https://git.coding.net/binarywang/weixin-java-tools.git + +=========== +## 可参考的Demo项目 +#### 目前都是公众号的,风格不同,欢迎提供更多的demo供新手参考: +1. https://github.com/wechat-group/weixin-java-mp-demo +1. https://github.com/wechat-group/weixin-java-mp-multi-demo (支持多公众号) +1. https://github.com/wechat-group/weixin-java-tools-springmvc +1. https://github.com/wechat-group/weixin-java-mp-demo-springboot + ## Maven & Gradle 最新正式版本 * 公众号(订阅号、服务号): @@ -63,19 +80,3 @@ gradle: compile 'com.github.binarywang:weixin-java-cp:2.4.0' ``` -=========== - -#### 本项目主要存放在github上,地址为 : -* https://github.com/wechat-group/weixin-java-tools -* ===========但同时会在其他几个网站同步更新,地址分别是: -* https://bitbucket.org/binarywang/weixin-java-tools -* http://git.oschina.net/binary/weixin-java-tools -* https://git.coding.net/binarywang/weixin-java-tools.git - -=========== -## 可参考的Demo项目 -#### 目前都是公众号的,风格不同,欢迎提供更多的demo供新手参考: -1. https://github.com/wechat-group/weixin-java-mp-demo -1. https://github.com/wechat-group/weixin-java-mp-multi-demo (支持多公众号) -1. https://github.com/wechat-group/weixin-java-tools-springmvc -1. https://github.com/wechat-group/weixin-java-mp-demo-springboot From 0d618242999cff5792e421a9ac45a259a737b038 Mon Sep 17 00:00:00 2001 From: Binary Wang Date: Fri, 30 Dec 2016 23:47:46 +0800 Subject: [PATCH 5/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3500d7ee..77d4a2f8 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Weixin Java Tools 微信公众号/企业号开发Java SDK ### 注意事项: 1. 声明: ***本项目Fork自chanjarster/weixin-java-tools,但由于原项目已停止维护,故单独维护和发布,且发布到maven上的groupId也会不同,详细信息见下文。*** -1. 最新更新:2016-11-30 发布2.4.0正式版! +1. 最新更新:**2016-11-30 发布[【2.4.0正式版】](https://github.com/Wechat-Group/weixin-java-tools/releases)**! 1. 自2.0.0版本以来,公众号的接口调整比较大,主要是为了解决主接口类过于庞大不方便管理的问题,将接口实现代码按模块进行拆分。 1. 详细开发文档请看 [Wiki](https://github.com/wechat-group/weixin-java-tools/wiki),部分文档可能未能及时更新,如有发现,可以及时上报或者自行修改。 1. 微信公众号官方文档入口地址:http://mp.weixin.qq.com/wiki (注意,从网上搜到的文档有的虽然地址前面跟这个一样,但明显左侧菜单不一致,是旧的文档,注意不要看错文档)。 From 876aa88f14032bf128e0a01f8740a0682986a94d Mon Sep 17 00:00:00 2001 From: Binary Wang Date: Fri, 30 Dec 2016 23:51:35 +0800 Subject: [PATCH 6/7] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 77d4a2f8..ea6d1605 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ Weixin Java Tools 微信公众号/企业号开发Java SDK 1. 声明: ***本项目Fork自chanjarster/weixin-java-tools,但由于原项目已停止维护,故单独维护和发布,且发布到maven上的groupId也会不同,详细信息见下文。*** 1. 最新更新:**2016-11-30 发布[【2.4.0正式版】](https://github.com/Wechat-Group/weixin-java-tools/releases)**! 1. 自2.0.0版本以来,公众号的接口调整比较大,主要是为了解决主接口类过于庞大不方便管理的问题,将接口实现代码按模块进行拆分。 -1. 详细开发文档请看 [Wiki](https://github.com/wechat-group/weixin-java-tools/wiki),部分文档可能未能及时更新,如有发现,可以及时上报或者自行修改。 +1. 详细开发文档请看 [【Wiki】](https://github.com/wechat-group/weixin-java-tools/wiki),部分文档可能未能及时更新,如有发现,可以及时上报或者自行修改。 1. 微信公众号官方文档入口地址:http://mp.weixin.qq.com/wiki (注意,从网上搜到的文档有的虽然地址前面跟这个一样,但明显左侧菜单不一致,是旧的文档,注意不要看错文档)。 1. 各个模块的Javadoc可以在线查看:[weixin-java-mp](https://binarywang.github.io/weixin-java-mp-javadoc/)、[weixin-java-common](https://binarywang.github.io/weixin-java-common-javadoc/)、[weixin-java-cp](https://binarywang.github.io/weixin-java-cp-javadoc/) -1. 本SDK要求的最低JDK版本是7,为满足少量还在使用JDK6的用户的需求,特意抽出独立的代码分支项目,请参考 https://github.com/binarywang/weixin-java-tools-for-jdk6 ,其他更早的JDK版本则需要自己改造实现。 -1. 有新功能需求,发现BUG,或者由于微信官方接口调整导致的代码问题,可以直接在[Issues](https://github.com/Wechat-Group/weixin-java-tools/issues)页提出issue,便于讨论追踪问题; -1. 如果想贡献代码,请阅读[贡献代码指南](CONTRIBUTION.md)。 +1. 本SDK要求的最低JDK版本是7,为满足少量还在使用JDK6的用户的需求,特意抽出独立的代码分支项目,请参考[【此项目】]( https://github.com/binarywang/weixin-java-tools-for-jdk6) ,其他更早的JDK版本则需要自己改造实现。 +1. 有新功能需求,发现BUG,或者由于微信官方接口调整导致的代码问题,可以直接在[【Issues】](https://github.com/Wechat-Group/weixin-java-tools/issues)页提出issue,便于讨论追踪问题; +1. 如果想贡献代码,请阅读[【代码贡献指南】](CONTRIBUTION.md)。 =========== From d9cbf4cb497b03193b67a309f3952219b0fde37c Mon Sep 17 00:00:00 2001 From: Binary Wang Date: Sat, 31 Dec 2016 00:03:48 +0800 Subject: [PATCH 7/7] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ea6d1605..c36e4dbd 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,10 @@ Weixin Java Tools 微信公众号/企业号开发Java SDK 1. 声明: ***本项目Fork自chanjarster/weixin-java-tools,但由于原项目已停止维护,故单独维护和发布,且发布到maven上的groupId也会不同,详细信息见下文。*** 1. 最新更新:**2016-11-30 发布[【2.4.0正式版】](https://github.com/Wechat-Group/weixin-java-tools/releases)**! 1. 自2.0.0版本以来,公众号的接口调整比较大,主要是为了解决主接口类过于庞大不方便管理的问题,将接口实现代码按模块进行拆分。 -1. 详细开发文档请看 [【Wiki】](https://github.com/wechat-group/weixin-java-tools/wiki),部分文档可能未能及时更新,如有发现,可以及时上报或者自行修改。 -1. 微信公众号官方文档入口地址:http://mp.weixin.qq.com/wiki (注意,从网上搜到的文档有的虽然地址前面跟这个一样,但明显左侧菜单不一致,是旧的文档,注意不要看错文档)。 +1. SDK详细开发文档请查阅 [【Wiki】](https://github.com/wechat-group/weixin-java-tools/wiki),部分文档可能未能及时更新,如有发现,可以及时上报或者自行修改。 1. 各个模块的Javadoc可以在线查看:[weixin-java-mp](https://binarywang.github.io/weixin-java-mp-javadoc/)、[weixin-java-common](https://binarywang.github.io/weixin-java-common-javadoc/)、[weixin-java-cp](https://binarywang.github.io/weixin-java-cp-javadoc/) 1. 本SDK要求的最低JDK版本是7,为满足少量还在使用JDK6的用户的需求,特意抽出独立的代码分支项目,请参考[【此项目】]( https://github.com/binarywang/weixin-java-tools-for-jdk6) ,其他更早的JDK版本则需要自己改造实现。 -1. 有新功能需求,发现BUG,或者由于微信官方接口调整导致的代码问题,可以直接在[【Issues】](https://github.com/Wechat-Group/weixin-java-tools/issues)页提出issue,便于讨论追踪问题; +1. 如有新功能需求,发现BUG,或者由于微信官方接口调整导致的代码问题,可以直接在[【Issues】](https://github.com/Wechat-Group/weixin-java-tools/issues)页提出issue,便于讨论追踪问题; 1. 如果想贡献代码,请阅读[【代码贡献指南】](CONTRIBUTION.md)。 ===========