Merge pull request #215 from cryptape/rc/v0.25.1

Release v0.25.1

README.md

@@ -17,3 +17,82 @@ The `cita-sdk-js` library is a collection of packages which contains specific fu
 # Notice
 
 Websocket is supported, but the pub/sub is not completed in CITA for now.
+
+
+# Contributing
+
+### Repository
+https://github.com/cryptape/cita-sdk-js
+
+### Tech Stack
+
+* Node: 9.4.0
+* Language: TypeScript
+* Library: Web3.js
+* Dependency Manage: lerna、yarn
+
+
+### Task Management
+https://github.com/cryptape/cita-sdk-js/issues
+
+### Coding Style
+lint tool: ESLint
+The lint tool related configuration file is in `/packages/cita-sdk/.eslintrc.js`.
+
+### Commit Style
+Github Flow Guide (https://guides.github.com/introduction/flow/)
+
+### Version
+
+`@cryptape/cita-sdk` strictly abides by Semver, and is compatible with [CITA](https://github.com/cryptape/cita) by `MAJOR` and `MINOR` version, e.g. `@cryptape/[email protected]` will work perfectly with `[email protected]`.
+
+### How To Test
+
+**Build:**
+
+```bash
+$ git clone https://github.com/cryptape/cita-sdk-js.git & cd ./cita-sdk-js
+$ git submodule update --init --remote --recursive
+$ yarn install
+$ yarn bootstrap
+$ yarn build 
+```
+
+**Configure Environment:**
+
+Find the `.env.example` file in the `packages/cita-sdk` and `packages/cita-signer` directories, rename it to `.env`, and modify the configuration in the file.
+
+**Run Tests:**
+
+```bash
+$ yarn test
+```
+
+### How To Publish
+
+```bash
+$ npm login // Log in to the npm account with publishing permissions.
+$ lerna version [bump]
+$ npm publish
+```
+
+The version upgrade does not require manual modification of `package.json`. After the release modified code is merged into the master, the publisher uses `lerna version [bump]` to upgrade the version and publish it to npm.
+
+### Push Tag
+
+**Naming Rules:**
+
+* cita-sdk
+    * `@cryptape/[email protected]`
+        * `x.y` follows the version number of CITA.
+        * `z` is defined by the SDK itself, modified when adding or modifying a feature.
+* cita-signer
+    * `@cryptape/[email protected]`
+        * x: MAJOR version, when you make incompatible API changes.
+        * y: MINOR version, when you add functionality in a backwards compatible manner.
+        * z: STAGE version, when you make backwards compatible bug fixes.
+* cita-web-debugger
+    * `[email protected]`
+        * x: MAJOR version, when you make incompatible API changes.
+        * y: MINOR version, when you add functionality in a backwards compatible manner.
+        * z: STAGE version, when you make backwards compatible bug fixes.

docs/zh-CN/overview.md

@@ -16,3 +16,83 @@
 # 需注意
 
 Websocket 链接已支持, 但是 pub/sub 模式尚未在 CITA 上实现.
+
+
+# 贡献
+
+### 代码库
+https://github.com/cryptape/cita-sdk-js
+
+### 技术栈
+
+* Node: 9.4.0
+* Language: TypeScript
+* Library: Web3.js
+* Dependency Manage: lerna、yarn
+
+
+### 任务管理
+https://github.com/cryptape/cita-sdk-js/issues
+
+### 代码编码规范
+lint tool: ESLint
+lint tool 相关配置文件在 /packages/cita-sdk/.eslintrc.js
+
+### 代码提交规范
+Github Flow Guide (https://guides.github.com/introduction/flow/)
+
+### 版本号规则
+
+`@cryptape/cita-sdk` 严格尊崇 Semver, 并且始终与 [CITA](https://github.com/cryptape/cita) 的 `MAJOR` 和 `MINOR` 版本号保持一致。
+
+### 如何测试
+
+**编译：**
+
+```bash
+$ git clone https://github.com/cryptape/cita-sdk-js.git & cd ./cita-sdk-js
+$ git submodule update --init --remote --recursive
+$ yarn install
+$ yarn bootstrap
+$ yarn build 
+```
+
+**配置环境参数：**
+找到 packages/cita-sdk 和 packages/cita-signer 下的 .env.example 文件，重命名为 .env，并修改文件中的配置。
+
+**运行测试：**
+
+```bash
+$ yarn test
+```
+
+### 如何发布
+
+```bash
+$ npm login // 登录有发布权限的 npm 账号
+$ lerna version [bump]
+$ npm publish
+```
+
+版本升级不需要手动修改 package.json，在release修改的代码合并到master之后，由发布者使用 lerna version [bump] 升级版本并发布到npm。
+
+### Push Tag
+
+**命名规则：**
+
+* cita-sdk
+    * `@cryptape/[email protected]`
+        * x.y 跟随 CITA 的版本号。
+        * z 由 SDK 自己定义：修复或增加 feature 则变化。
+* cita-signer
+    * `@cryptape/[email protected]`
+        * x：主版本号，当功能模块有较大的变动。
+        * y：子版本号，当功能有一定的增加或变化。
+        * z：阶段版本号，一般是 Bug 修复或是一些小的变动。
+* cita-web-debugger
+    * `[email protected]`
+        * x：主版本号，当功能模块有较大的变动。
+        * y：子版本号，当功能有一定的增加或变化。
+        * z：阶段版本号，一般是 Bug 修复或是一些小的变动。
+
+

package.json

@@ -57,7 +57,6 @@
   "dependencies": {
     "axios": "^0.19.0",
     "crypto-js": "^3.1.9-1",
-    "ec": "^0.0.1",
     "elliptic": "^6.4.0",
     "google-protobuf": "^3.5.0"
   }