WxJava代碼貢獻指南

代碼貢獻指南

1. 首先非常歡迎和感謝對本項目發起

   Pull Request

   的同學。
2. 特别提示：請務必在 

   develop

    分支送出 

   PR

   ，

   release

    分支目前僅是正式版的代碼，即釋出正式版本後才會從 

   develop

    分支進行合并。
3. 本項目代碼風格為使用2個空格代表一個Tab，是以在送出代碼時請注意一下，否則很容易在IDE格式化代碼後與原代碼産生大量diff，這樣會給其他人閱讀代碼帶來極大的困擾。
4. 為了便于設定，本項目引入

   editorconfig

   支援，請使用Eclipse的同學在貢獻代碼前安裝相關插件，而

   IntelliJ IDEA

   新版本自帶支援，如果沒有可自行安裝插件。
5. 送出代碼前，請檢查代碼是否已經格式化，并且保證新增加或者修改的方法都有完整的參數說明，而public方法必須擁有相應的單元測試并通過測試。
6. 本項目可以采用兩種方式接受代碼貢獻：

• 第一種就是基于Git Flow開發流程，是以在發起Pull Request的時候請選擇develop分支，詳細步驟參考後文，推薦使用此種方式貢獻代碼。
• （暫停此種方式，請使用第一種）另外一種貢獻代碼的方式就是加入SDK Developers開發組，前提是對自己的代碼足夠自信就可以申請加入，加入之後可以随時直接送出代碼，但要注意對所做的修改或新增的代碼進行單元測試，保證送出代碼沒有明顯問題。

PR方式貢獻代碼步驟

• 在 GitHub 上 

  fork

   到自己的倉庫，如 

  my_user/WxJava

  ，然後 

  clone

   到本地，并設定使用者資訊。

$ git clone [email protected]:{your-github-username}/WxJava.git
$ cd WxJava
$ git config user.name "yourname"
$ git config user.email "your email"      

• 修改代碼後送出，并推送到自己的倉庫。

$ #do some change on the content
$ git commit -am "Fix issue #1: change something"
$ git push      

• 在 GitHub 網站上送出 Pull Request。
• 定期使用項目倉庫内容更新自己倉庫内容。

$ 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