big_keeper 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6967a93e88df9fe276ccf6226dc5b12a921ef49e
-  data.tar.gz: 20939ca9f234ae42500e583ce44b9d09c17a75ad
+  metadata.gz: 5275d4933523f33d0526dc52a9491079d9bc3b82
+  data.tar.gz: 2dbd46bcd8f579101166731574b21cfda7ae267a
 SHA512:
-  metadata.gz: 87d3900605fe6f45777a4fdfc00b5b9006505ec6b14a24c5001c298e02c3bafb4c0206fd29eb11a940882c4912a2ef5895c684ed31adfd09776abac8d2c7fc46
-  data.tar.gz: 36c0f7aa3abc80fc0d7ba86e87b1d30b0089294ed41b90243c8cad70cb251c3c549bdeb21bf19d73c5d7269bcc36e35ed4da7082f7cfda389b16c7d7076859d4
+  metadata.gz: 9aa603c3784108574da97f8a0236a0609dae2fec59ad5bb1131633e1b52dd4c5f71451aaf06d8da269673ea16772ffde7e949b8f90682417f74d94fcfc2f17e1
+  data.tar.gz: 0591f8852f2ba2ebc071c75a3765eac92549b08cb48700fec90466e79e3d91dc3f847e7b370febb596ecb32b86b8ab4d810e4c4b06aec90f548af172ff5171c7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    big_keeper (0.6.0)
+    big_keeper (0.7.1)
       big_stash (~> 0.1)
       cocoapods
       colorize

data/README.md

@@ -1,50 +1,109 @@
-[中文](docs/zh-CN/README.md)
+![](./resources/banner.png)
+
+[English](./docs/en-US/README.md)
 
 ---
 
-# big-keeper - All in home project
+# bigkeeper
 
-[![Build Status](https://travis-ci.org/BigKeeper/big-keeper.svg?branch=master)](https://travis-ci.org/BigKeeper/big-keeper)
+[![Build Status](https://travis-ci.org/BigKeeper/bigkeeper.svg?branch=master)](https://travis-ci.org/BigKeeper/bigkeeper)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c6dc4161e84fcec9a890/maintainability)](https://codeclimate.com/github/BigKeeper/big-keeper/maintainability)
 [![Gem Version](https://badge.fury.io/rb/big_keeper.svg)](https://rubygems.org/gems/big_keeper)
 [![Language: Ruby](https://img.shields.io/badge/language-Ruby-da212f.svg)](https://www.ruby-lang.org/)
 [![License](https://img.shields.io/badge/license-MIT-000000.svg)](https://github.com/BigKeeper/big-keeper/blob/master/LICENSE)
 [![Gitter](https://img.shields.io/gitter/room/BigKeeper/BigKeeper.svg)](https://gitter.im/Big-Keeper/Lobby)
 
-big-keeper is an efficiency improvement for iOS modular development, iOSer using this tool can make modular development easier.
+bigkeeper 是一个 **iOS&Android 模块化项目**效率提升工具，使用这个工具后，开发者**在主项目内**即可完成**包括其他业务模块在内**所有代码的编写和管理。
+
+> 注：目前只支持依赖 CocoaPods 管理的模块化工程。
+
+我们借鉴 CocoaPods 的做法，开发团队只需要在主项目中加入一个 Bigkeeper 文件，然后利用我们提供的 `bigkeeper` 工具，即可更便捷的实现**代码分支**和**业务模块**的管理；另外，通过我们提供的工具，也能帮助开发者养成更规范的日常开发习惯，减轻项目管理者的负担。
+
+## 应用场景
+
+在模块化项目的过渡阶段，我们往往会碰到业务拆分不是那么彻底的情况（PS：比如主项目中仍然存在业务相关代码），这样就会导致一系列问题：
+
+- 开发者开发一个 feature 时需要维护多个项目的分支，同时还要频繁修改主项目的 `Podfile`;
+- 项目管理者需要花很大精力去和团队成员同步项目管理规范流程，尤其对于新人，挑战很大；
+- 开发过程中如果碰到突发情况需要开新分支处理问题时对当前工作区的保存操作会很繁琐（PS：因为涉及到多个项目）；
+- 日常开发过程中类似 commit、pull、push 等操作比较繁琐（PS：因为涉及到多个项目）。
+
+bigkeeper 的出现就是为了解决这些问题。
+
+> 注：也有很多人认为直接做一个完整的组件化项目更合理，而不需要采用这样曲折的方案，但是很多时候我们并没有这么多的精力直接去做这些事情，bigkeeper 存在的价值也是为了帮助开发团队在** iOS&Android 模块化项目过渡阶段**能更轻松的往前走。
 
-## Installation
+## 安装
 
-Add this line to your application's Gemfile:
+- 当作 Ruby Gem 使用：
+  在项目的 Gemfile 中加入下面这行：
 
-```ruby
-gem 'big_keeper'
-```
+  ```ruby
+  gem 'big_keeper'
+  ```
 
-And then execute:
+  然后执行：
 
     $ bundle
 
-Or install it yourself as:
+- 直接安装：
 
     $ gem install big_keeper
 
-## Usage
+## 使用方法
+
+> 注：每个流程我们都提供详细的流程图来让你了解我们都做了些什么，为了方便你更好的了解我们的流程，我们提供了一个流程参考图，如下：
+>
+> ![](./resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.001.jpeg)
+
+- [Bigkeeper 文件配置](./docs/zh-CN/BIGKEEPER_FILE.md)
+- `bigkeeper` 工具使用：
+
+  直接在命令行执行 `bigkeeper` 可以查看其提供的所有功能：
+
+  ```
+  NAME
+      bigkeeper - Efficiency improvement for iOS&Android modular development, iOSer&Android using this tool can make modular development easier.
+
+  SYNOPSIS
+      bigkeeper [global options] command [command options] [arguments...]
+
+  GLOBAL OPTIONS
+      --help         - Show this message
+      -p, --path=arg - (default: ./)
+      -u, --user=arg - (default: mmoaay)
+
+      -v, --ver=arg  - (default: Version in Bigkeeper file)
+
+  COMMANDS
+      feature - Feature operations
+      help    - Shows a list of commands or help for one command
+      hotfix  - Hotfix operations
+      podfile - Podfile operation
+      release - Release operations
+      version - Version
+  ```
 
-Run `big-keeper` to learn how to use big-keeper.
+  全局参数如下：
 
-## Development
+  - -p, --path：主项目所在的目录，默认是执行 bigkeeper 命令的当前目录；
+  - -v, --ver：版本号，如果没有指定的话，会以主项目 [Bigkeeper 文件](BIGKEEPER_FILE.md)中指定的版本为准。
+  - -u, --user：用户名，默认是 git global config 的 user.name，会显示在命令提示信息中，比如上述提示信息中的默认用户名是 mmoaay
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  功能列表如下：
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+  - [feature](./docs/zh-CN/FEATURE&HOTFIX.md)：功能开发流程；
+  - [hotfix](./docs/zh-CN/FEATURE&HOTFIX.md)：线上修复流程；
+  - [release](./docs/zh-CN/RELEASE.md)：发布流程；
+  - [podfile](./docs/zh-CN/PODFILE.md)：Podfile 操作流程；
+  - version：查看 bigkeeper 当前版本号；
+  - help：查看 bigkeeper 帮助文档。
 
-## Contributing
+## 其他
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/BigKeeper/big-keeper.
+- [一些建议](./docs/zh-CN/RECOMMEND.md)
 
-## License
+## 协议
 
 ![](https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/License_icon-mit-88x31-2.svg/128px-License_icon-mit-88x31-2.svg.png)
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+bigkeeper 基于 MIT 协议进行分发和使用，更多信息参见协议文件。

data/docs/en-US/README.md

@@ -0,0 +1,50 @@
+[中文](../zh-CN/README.md)
+
+---
+
+# bigkeeper - All in home project
+
+[![Build Status](https://travis-ci.org/BigKeeper/bigkeeper.svg?branch=master)](https://travis-ci.org/BigKeeper/bigkeeper)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c6dc4161e84fcec9a890/maintainability)](https://codeclimate.com/github/BigKeeper/big-keeper/maintainability)
+[![Gem Version](https://badge.fury.io/rb/big_keeper.svg)](https://rubygems.org/gems/big_keeper)
+[![Language: Ruby](https://img.shields.io/badge/language-Ruby-da212f.svg)](https://www.ruby-lang.org/)
+[![License](https://img.shields.io/badge/license-MIT-000000.svg)](https://github.com/BigKeeper/big-keeper/blob/master/LICENSE)
+[![Gitter](https://img.shields.io/gitter/room/BigKeeper/BigKeeper.svg)](https://gitter.im/Big-Keeper/Lobby)
+
+bigkeeper is an efficiency improvement for iOS&Android modular development, iOSer&Android using this tool can make modular development easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'big_keeper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install big_keeper
+
+## Usage
+
+Run `bigkeeper` to learn how to use bigkeeper.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BigKeeper/bigkeeper.
+
+## License
+
+![](https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/License_icon-mit-88x31-2.svg/128px-License_icon-mit-88x31-2.svg.png)
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/docs/zh-CN/BIGKEEPER_FILE.md

@@ -1,6 +1,6 @@
 # Bigkeeper 文件
 
-首先，我们在主项目 Podfile 所在的目录加入 `Bigkeeper` 文件。
+首先，我们在主项目 Podfile 所在的目录加入 **Bigkeeper** 文件。
 
 ## 配置版本
 
@@ -59,4 +59,4 @@ end
 >
 > 2. 默认我们会把本地路径配置成 `../{业务模块在 Podfile 中的名字}` 的形式，因为大部分情况下，我们会把项目都放在同级目录下，这也是我们推荐的；
 >
-> 3. 另外，在使用 big-keeper 相关功能时，如果某些业务模块并没有 clone 到本地，big-keeper 会根据之前配置的业务模块远程 git 地址 clone 业务模块仓库到**主项目同级目录下**。
+> 3. 另外，在使用 bigkeeper 相关功能时，如果某些业务模块并没有 clone 到本地，bigkeeper 会根据之前配置的业务模块远程 git 地址 clone 业务模块仓库到**主项目同级目录下**。

data/docs/zh-CN/FEATURE&HOTFIX.md

@@ -0,0 +1,121 @@
+# feature - 功能开发流程 & hotfix - 线上修复流程
+
+> 注：hotfix 除了基础分支是 **master**，其他操作和 feature 一致，所以我们这里以 feature 为例说明。
+
+直接在命令行执行 `bigkeeper feature --help` 可以查看其提供的所有功能：
+
+```
+NAME
+    feature - Feature operations
+
+
+SYNOPSIS
+    bigkeeper [global options] feature delete
+    bigkeeper [global options] feature finish
+    bigkeeper [global options] feature list
+    bigkeeper [global options] feature pull
+    bigkeeper [global options] feature push
+    bigkeeper [global options] feature start
+    bigkeeper [global options] feature switch
+    bigkeeper [global options] feature update
+
+COMMANDS
+    delete - Delete feature with name
+    finish - Finish current feature
+    list   - List all the features
+    pull   - Pull remote changes for current feature
+    push   - Push local changes to remote for current feature
+    start  - Start a new feature with name for given modules and main project
+    switch - Switch to the feature with name
+    update - Update modules for the feature with name
+```
+
+功能列表如下：
+
+- start：
+  开始一个新的 feature，输入参数依次为：
+  - feature 的名字;
+  - 开发该 feature 需要改动的业务模块名。可以多个，用空格隔开；如果不指定，取 **Bigkeeper 文件中所有的业务模块名**。
+- finish：结束当前 feature；
+- switch：切换到一个已经存在的 feature，输入参数为 feature 名；
+- update：
+  更新一个 feature 需要改动的业务模块，输入参数依次为：
+  - feature 的名字;
+  - 开发该 feature 需要改动的业务模块名。可以多个，用空格隔开；如果不指定，取 **Bigkeeper 文件中所有的业务模块名**。
+- pull：拉取当前 feature 主项目和业务模块的远程 git 仓库更新；
+- push：提交并推送当前 feature 主项目和业务模块的本地变更到远程 git 仓库，输入参数为提交信息；
+- delete：根据 featue 名删除主项目和业务模块所有相关分支；（PS：慎用，因为会删除本地和远程所有相关分支）
+- list：显示当前的 feature 列表。
+
+## 各个流程的使用场景
+
+- 如果需要开发新的功能，使用 bigkeeper feature start；
+- 开发功能过程中如果发现某个模块其实不用改动，使用 bigkeeper feature update 来把这个模块从这个 feature 移除；
+- 使用 bigkeeper feature pull 来同步主项目和相关业务模块远端变更；
+- 使用 bigkeeper feature push 来推送主项目和相关业务模块变更到远端；
+- 使用 bigkeeper feature switch 来切换 feature，比如：两个功能并行开发的时候，就可以用这个命令互相切换了；
+- 功能开发完成，需要提交 PR 时，使用 bigkeeper feature finish 结束开发；
+- 如果开发过程中突然有新的功能需要紧急开发，直接使用 bigkeeper feature start 进行新功能开发，旧功能未提交的内容我们会保存在 stash 中。
+
+## feature 的工作区
+
+![](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.002.jpeg)
+
+feature 的工作区主要由两部分组成：
+
+- 主项目；
+- 相关业务模块，我们把 Podfile 中引用方式为 `:path => {业务模块本地路径}` 的模块做为相关业务模块。
+
+主项目和每个相关业务模块又有各自的工作区，由三个部分组成：
+
+- 当前代码区改动；
+- stash 缓存区，当用户需要切换新的 feature 时，对于用户来不及提交的改动，我们会缓存到各个项目的 stash 中，（PS：所以代码突然不见了不要担心，都在 git 的 stash 里面），而当用户切换回某个 feature 时，我们会把和该 feature 分支同名的 stash 恢复回来，从而使用户可以继续开发之前未完成的部分，因为需要通过 feature 的分支名来匹配 stash，而 git stash 又没有提供给 stash 命名的功能，所以我们实现了 [big-stash](https://github.com/BigKeeper/big-stash) 来完成这个功能；
+- git。
+
+## 工作区缓存流程
+
+![stash 当前工作区](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.003.jpeg)
+
+## master／develop 分支状态检查流程
+
+![检查 master／develop 分支状态](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.004.jpeg)
+
+## 切换分支流程
+
+![切换分支](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.005.jpeg)
+
+## 同步业务模块与主项目分支流程
+
+![同步业务模块与主项目分支](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.006.jpeg)
+
+## finish 业务模块 feature／hotfix 流程
+
+![finish 业务模块 feature／hotfix](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.007.jpeg)
+
+## 从 feature／hotfix 移除模块流程
+
+![从 feature／hotfix 移除模块](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.008.jpeg)
+
+## feature start 流程
+
+![start](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.009.jpeg)
+
+## feature finish 流程
+
+![finish](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.010.jpeg)
+
+## feature switch 流程
+
+![switch](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.011.jpeg)
+
+## feature update 流程
+
+![update](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.012.jpeg)
+
+## feature pull 流程
+
+![pull](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.013.jpeg)
+
+## feature push 流程
+
+![push](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.014.jpeg)

data/docs/zh-CN/PODFILE.md

@@ -0,0 +1,43 @@
+# podfile - podfile版本控制流程
+
+直接在命令行执行  `bigkeeper podfile --help` 可以查看其提供的所有功能
+
+```
+NAME
+    podfile - Podfile operation
+
+SYNOPSIS
+    bigkeeper [global options] podfile [command options] detect
+    bigkeeper [global options] podfile [command options] lock
+    bigkeeper [global options] podfile [command options] upgrade
+
+COMMAND OPTIONS
+    --pod, --podfile=arg - (default: none)
+
+COMMANDS
+    detect  - Detect podname should be locked.
+    lock    - Lock podname should be locked.
+    upgrade - Update module version
+
+```
+
+全局参数如下：
+
+- -pod  --podfile ：podfile文件路径
+
+功能列表如下：
+
+- detect：
+    检测当前同步到本地的项目工程中podfile，得到未锁定的第三方库。
+    如果存在，提示需要指定版本。
+    如果不存在，提示无需指定版本的第三方库。
+
+- lock:
+    检测到存在需指定代版本的三方库后，执行lock指令对所有需要锁定的库进行锁定。
+
+- upgrade:
+    检测配置文件中指定业务库，有无最新可更新版本。
+
+  ## podfile lock 流程
+
+    ![](../../resources/readme/big-keeper-readme.011.png)

data/docs/zh-CN/README.md

@@ -1,21 +1,21 @@
-[English](../../README.md)
+[English](../en-US/README.md)
 
 ---
 
-# big-keeper - 我好像做了一个假的模块化项目
+# bigkeeper
 
-[![Build Status](https://travis-ci.org/BigKeeper/big-keeper.svg?branch=master)](https://travis-ci.org/BigKeeper/big-keeper)
+[![Build Status](https://travis-ci.org/BigKeeper/bigkeeper.svg?branch=master)](https://travis-ci.org/BigKeeper/bigkeeper)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c6dc4161e84fcec9a890/maintainability)](https://codeclimate.com/github/BigKeeper/big-keeper/maintainability)
 [![Gem Version](https://badge.fury.io/rb/big_keeper.svg)](https://rubygems.org/gems/big_keeper)
 [![Language: Ruby](https://img.shields.io/badge/language-Ruby-da212f.svg)](https://www.ruby-lang.org/)
 [![License](https://img.shields.io/badge/license-MIT-000000.svg)](https://github.com/BigKeeper/big-keeper/blob/master/LICENSE)
 [![Gitter](https://img.shields.io/gitter/room/BigKeeper/BigKeeper.svg)](https://gitter.im/Big-Keeper/Lobby)
 
-big-keeper 是一个**iOS模块化项目过渡阶段**的效率提升工具，使用这个工具后，开发者**在主项目内**就可以完成**包括其他业务模块在内**所有代码的编写和管理。
+bigkeeper 是一个 **iOS&Android 模块化项目**效率提升工具，使用这个工具后，开发者**在主项目内**即可完成**包括其他业务模块在内**所有代码的编写和管理。
 
 > 注：目前只支持依赖 CocoaPods 管理的模块化工程。
 
-我们仿照 CocoaPods 的做法，开发团队只需要在主项目中加入一个 Bigkeeper 文件，然后利用我们提供的 `big-keeper` 工具，即可更便捷的实现**代码分支**和**业务模块**的管理；另外，通过我们提供的工具，也能帮助开发者养成更规范的日常开发习惯，减轻项目管理者的负担。
+我们借鉴 CocoaPods 的做法，开发团队只需要在主项目中加入一个 Bigkeeper 文件，然后利用我们提供的 `bigkeeper` 工具，即可更便捷的实现**代码分支**和**业务模块**的管理；另外，通过我们提供的工具，也能帮助开发者养成更规范的日常开发习惯，减轻项目管理者的负担。
 
 ## 应用场景
 
@@ -26,9 +26,9 @@ big-keeper 是一个**iOS模块化项目过渡阶段**的效率提升工具，
 - 开发过程中如果碰到突发情况需要开新分支处理问题时对当前工作区的保存操作会很繁琐（PS：因为涉及到多个项目）；
 - 日常开发过程中类似 commit、pull、push 等操作比较繁琐（PS：因为涉及到多个项目）。
 
-big-keeper 的出现就是为了解决这些问题。
+bigkeeper 的出现就是为了解决这些问题。
 
-> 注：也有很多人认为直接做一个完整的组件化项目更合理，而不需要采用这样曲折的方案，但是很多时候我们并没有这么多的精力直接去做这些事情，big-keeper 存在的价值也是为了帮助开发团队在**iOS模块化项目过渡阶段**能更轻松的往前走。
+> 注：也有很多人认为直接做一个完整的组件化项目更合理，而不需要采用这样曲折的方案，但是很多时候我们并没有这么多的精力直接去做这些事情，bigkeeper 存在的价值也是为了帮助开发团队在 **iOS&Android 模块化项目过渡阶段**能更轻松的往前走。
 
 ## 安装
 
@@ -49,41 +49,59 @@ big-keeper 的出现就是为了解决这些问题。
 
 ## 使用方法
 
+> 注：每个流程我们都提供详细的流程图来让你了解我们都做了些什么，为了方便你更好的了解我们的流程，我们提供了一个流程参考图，如下：
+>
+> ![](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.001.jpeg)
+
 - [Bigkeeper 文件配置](BIGKEEPER_FILE.md)
-- `big-keeper` 工具使用：
+- `bigkeeper` 工具使用：
 
-  直接在命令行执行 `big-keeper` 可以查看其提供的所有功能：
+  直接在命令行执行 `bigkeeper` 可以查看其提供的所有功能：
 
   ```
   NAME
-      big-keeper - Efficiency improvement for iOS modular development, iOSer using this tool can make modular development easier.
+      bigkeeper - Efficiency improvement for iOS&Android modular development, iOSer&Android using this tool can make modular development easier.
 
   SYNOPSIS
-      big-keeper [global options] command [command options] [arguments...]
+      bigkeeper [global options] command [command options] [arguments...]
 
   GLOBAL OPTIONS
       --help         - Show this message
       -p, --path=arg - (default: ./)
+      -u, --user=arg - (default: mmoaay)
+
       -v, --ver=arg  - (default: Version in Bigkeeper file)
 
   COMMANDS
       feature - Feature operations
       help    - Shows a list of commands or help for one command
+      hotfix  - Hotfix operations
+      podfile - Podfile operation
       release - Release operations
+      version - Version
   ```
 
   全局参数如下：
 
-  - -p, --path：主项目所在的目录，默认是执行 big-keeper 命令的当前目录；
+  - -p, --path：主项目所在的目录，默认是执行 bigkeeper 命令的当前目录；
   - -v, --ver：版本号，如果没有指定的话，会以主项目 [Bigkeeper 文件](BIGKEEPER_FILE.md)中指定的版本为准。
+  - -u, --user：用户名，默认是 git global config 的 user.name，会显示在命令提示信息中，比如上述提示信息中的默认用户名是 mmoaay
 
   功能列表如下：
 
-  - [feature](FEATURE.md)：功能开发流程；
-  - [release](RELEASE.md)：版本发布流程。
+  - [feature](FEATURE&HOTFIX.md)：功能开发流程；
+  - [hotfix](FEATURE&HOTFIX.md)：线上修复流程；
+  - [release](RELEASE.md)：发布流程；
+  - [podfile](PODFILE.md)：Podfile 操作流程；
+  - version：查看 bigkeeper 当前版本号；
+  - help：查看 bigkeeper 帮助文档。
+
+## 其他
+
+- [一些建议](RECOMMEND.md)
 
 ## 协议
 
 ![](https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/License_icon-mit-88x31-2.svg/128px-License_icon-mit-88x31-2.svg.png)
 
-big-keeper 基于 MIT 协议进行分发和使用，更多信息参见协议文件。
+bigkeeper 基于 MIT 协议进行分发和使用，更多信息参见协议文件。

data/docs/zh-CN/RECOMMEND.md

@@ -0,0 +1,22 @@
+# 代码管理规范
+
+## 基本原则
+
+- master 分支保证是线上最新包的代码。
+- develop 分支保证是下一个发布包的代码，随时支持发布。
+
+### 开发和测试流程
+
+feature 分支为 feature 开发和提测分支，提测前需要 rebase/merge develop 的代码，测试完成后，pr 到 develop 分支，确定下个版本发布才 accept pr。
+
+### develop 分支 bug 修复流程
+
+单独开分支，fix 完成后，pr 到 develop 分支。
+
+### 发布流程
+
+develop->release->master 瞬间操作，release 不能长期存在。
+
+### hotfix 流程
+
+master 拉出 hotfix，fix 完成后分别 pr 到 master、develop 两个分支，完成后新建发布版本。

data/docs/zh-CN/RELEASE.md

@@ -27,14 +27,17 @@ COMMANDS
     - start: 开始发布主工程的某个版本
     - finish: 完成发布版本
 - module: 发布模块命令
+    - start: 开始发布模块的某个版本
+    - finish: 完成发布版本
 
 ## release 的工作区
   同 feature 工作区
 
 ## release home start 流程
-![](../../resources/readme/big-keeper-readme.008.jpeg)
+![](../../resources/readme/big-keeper-readme.008.png)
 ## release home finish 流程
-![](../../resources/readme/big-keeper-readme.009.jpeg)
-## release module 流程
-![](../../resources/readme/big-keeper-readme.010.jpeg)
-
+![](../../resources/readme/big-keeper-readme.009.png)
+## release module  start 流程
+![](../../resources/readme/big-keeper-readme.010.png)
+## release module  finish 流程
+![](../../resources/readme/big-keeper-readme.012.png)

data/lib/big_keeper/command/feature&hotfix/delete.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby
+
+require 'big_keeper/util/podfile_operator'
+require 'big_keeper/util/gitflow_operator'
+require 'big_keeper/util/bigkeeper_parser'
+require 'big_keeper/util/logger'
+require 'big_keeper/util/pod_operator'
+
+require 'big_keeper/model/podfile_type'
+
+require 'big_keeper/service/stash_service'
+require 'big_keeper/service/module_service'
+
+
+module BigKeeper
+  def self.delete(path, user, name, type)
+    begin
+      # Parse Bigkeeper file
+      BigkeeperParser.parse("#{path}/Bigkeeper")
+      branch_name = "#{GitflowType.name(type)}/#{name}"
+
+      modules = BigkeeperParser.module_names
+
+      modules.each do |module_name|
+        module_full_path = BigkeeperParser.module_full_path(path, user, module_name)
+        GitService.new.verify_del(module_full_path, branch_name, module_name, type)
+      end
+
+      GitService.new.verify_del(path, branch_name, 'Home', type)
+    ensure
+    end
+  end
+end

data/lib/big_keeper/command/feature&hotfix/{feature_finish.rb → finish.rb}

@@ -10,39 +10,40 @@ require 'big_keeper/model/podfile_type'
 
 module BigKeeper
 
-  def self.feature_finish(path, user)
+  def self.finish(path, user, type)
     begin
       # Parse Bigkeeper file
       BigkeeperParser.parse("#{path}/Bigkeeper")
 
       modules = PodfileOperator.new.modules_with_type("#{path}/Podfile",
                                 BigkeeperParser.module_names, ModuleType::PATH)
-
       branch_name = GitOperator.new.current_branch(path)
-      Logger.error("Not a feature branch, exit.") unless branch_name.include? 'feature'
+
+      Logger.error("Not a #{GitflowType.name(type)} branch, exit.") unless branch_name.include? GitflowType.name(type)
 
       # Rebase modules and modify podfile as git
       modules.each do |module_name|
-        ModuleService.new.finish(path, user, module_name)
+        ModuleService.new.finish(path, user, module_name, branch_name, type)
       end
 
-      BigkeeperParser.module_names.each do |module_name|
+      Logger.highlight("Finish branch '#{branch_name}' for 'Home'")
+
+      # pod install
+      PodOperator.pod_install(path)
+
+      modules.each do |module_name|
         module_git = BigkeeperParser.module_git(module_name)
         PodfileOperator.new.find_and_replace("#{path}/Podfile",
                                              module_name,
                                              ModuleType::GIT,
-                                             GitInfo.new(module_git, GitType::BRANCH, 'develop'))
+                                             GitInfo.new(module_git, GitType::BRANCH, GitflowType.base_branch(type)))
       end
 
-      # pod install
-      PodOperator.pod_install(path)
-
-      Logger.highlight("Finish branch '#{branch_name}' for 'Home'")
       # Push home changes to remote
-      GitService.new.verify_push(path, "finish #{GitflowType.name(GitflowType::FEATURE)} #{branch_name}", branch_name, 'Home')
+      GitService.new.verify_push(path, "finish branch #{branch_name}", branch_name, 'Home')
 
       # Rebase Home
-      GitService.new.verify_rebase(path, 'develop', 'Home')
+      GitService.new.verify_rebase(path, GitflowType.base_branch(type), 'Home')
 
       `open #{BigkeeperParser.home_pulls()}`
     ensure

data/lib/big_keeper/command/feature&hotfix/{feature_pull.rb → pull.rb}

@@ -1,19 +1,19 @@
 require 'big_keeper/util/logger'
 
 module BigKeeper
-  def self.feature_pull(path, user)
+  def self.pull(path, user, type)
     begin
       # Parse Bigkeeper file
       BigkeeperParser.parse("#{path}/Bigkeeper")
-
       branch_name = GitOperator.new.current_branch(path)
-      Logger.error('Not a feature branch, exit.') unless branch_name.include? 'feature'
+
+      Logger.error("Not a #{GitflowType.name(type)} branch, exit.") unless branch_name.include? GitflowType.name(type)
 
       modules = PodfileOperator.new.modules_with_type("#{path}/Podfile",
                                                       BigkeeperParser.module_names, ModuleType::PATH)
 
       modules.each do |module_name|
-        ModuleService.new.pull(path, user, module_name, branch_name)
+        ModuleService.new.pull(path, user, module_name, branch_name, type)
       end
 
       Logger.highlight("Pull branch '#{branch_name}' for 'Home'...")