build(Workflow and README): New workflow and README updated

fix #39

Author: xiazeyu

.czrc

@@ -0,0 +1 @@
+{ "path": "cz-conventional-changelog" }

CHANGELOG.md

@@ -1,59 +1,22 @@
-## Change Log
-
-### upcoming (2017/11/13 12:50 +00:00)
-- [9997c22](https://github.com/EYHN/hexo-helper-live2d/commit/9997c225f5365833341359e28467263570e87720) build(Commit system and build flow): Commit system and build flow (@xiazeyu)
-- [76f70bf](https://github.com/EYHN/hexo-helper-live2d/commit/76f70bfe130d15d7c47bf681e88375046e3fbc14) docs: add CHANGELOG YEAH~~~~~ (@xiazeyu)
-
-### 2.1.3 (2017/11/11 14:33 +00:00)
-- [f9f535e](https://github.com/EYHN/hexo-helper-live2d/commit/f9f535e0e3fea2453b8f20d257ef7baa26250495) v2.1.3 (@xiazeyu)
-- [7e80cae](https://github.com/EYHN/hexo-helper-live2d/commit/7e80cae7d920758cc16cac8b6fe7c9a0e1866dd1) update readme and add opacity (BROKEN) (@xiazeyu)
-- [cb4468e](https://github.com/EYHN/hexo-helper-live2d/commit/cb4468e18ada4e6d9374de6245b4d1b8016e9bd4) Refix #26 (@xiazeyu)
-- [e4341d3](https://github.com/EYHN/hexo-helper-live2d/commit/e4341d32fd48add9824da2bf1bfcaea9785e291a) Tried to solve blur problem (@xiazeyu)
-- [3638fb4](https://github.com/EYHN/hexo-helper-live2d/commit/3638fb48f288ee437991027259e71ec4a4476b46) Fix README (@xiazeyu)
-- [9201848](https://github.com/EYHN/hexo-helper-live2d/commit/92018482fb347aec755a095ab0c81ed96a5f8b5e) Update version to 2.1.2 (@xiazeyu)
-- [680b441](https://github.com/EYHN/hexo-helper-live2d/commit/680b441b870837da59d0b58fed578d31c44b3664) compress jsons & pngs(#24) (@xiazeyu)
-- [88decdd](https://github.com/EYHN/hexo-helper-live2d/commit/88decddacd1df43a4f43af5c6624f87fd3c60607) Improve codes & fix bug (@xiazeyu)
-- [6d432b8](https://github.com/EYHN/hexo-helper-live2d/commit/6d432b849c42dae2bb581d6c9a8e596513b946e9) fix: bottomOffset to verticalOffset (@EYHN)
-- [8a30beb](https://github.com/EYHN/hexo-helper-live2d/commit/8a30bebefbe18a53a76cc7b2c85bf3ce2794f4d4) 2.1 release (@EYHN)
-- [97ad909](https://github.com/EYHN/hexo-helper-live2d/commit/97ad9099b9e837556d5c71e9344ac3a4a6dc6e6f) update version (@EYHN)
-- [94560f7](https://github.com/EYHN/hexo-helper-live2d/commit/94560f7b9cc528fb6ca539bccf1e66c92df261b2) change bottomOffset to verticalOffset (@EYHN)
-- [5fc7796](https://github.com/EYHN/hexo-helper-live2d/commit/5fc77963f0d5a5ddecf3a5acf3d8aba77227f0c5) Add custom model path at root directory (@xiazeyu)
-- [e8332a2](https://github.com/EYHN/hexo-helper-live2d/commit/e8332a24109dc8d86bd165d16ac598e4d0fcd623) Update README (@xiazeyu)
-- [7570106](https://github.com/EYHN/hexo-helper-live2d/commit/757010669e9d0321ff20d6d19dada5e7330e9ac1) Rebuild script (@xiazeyu)
-- [e18da32](https://github.com/EYHN/hexo-helper-live2d/commit/e18da326ec8a1ccb8d7a88e851ec3066b1703519) Improve file structure (@xiazeyu)
-- [48a84c7](https://github.com/EYHN/hexo-helper-live2d/commit/48a84c78563cb3755475c57ded56990ded3f3bdc) Fixed config issue (@xiazeyu)
-- [f22ce35](https://github.com/EYHN/hexo-helper-live2d/commit/f22ce35f592cee9a2146f394781d62729373480b) Fix bugs and improve coding (@xiazeyu)
-- [9045f96](https://github.com/EYHN/hexo-helper-live2d/commit/9045f96044b5a34c705255831c95361a03a81fc3) optimize attaching models' file structure (@xiazeyu)
-- [1ae7b69](https://github.com/EYHN/hexo-helper-live2d/commit/1ae7b69546be09d9c7c1bba1c43492f00f5d454a) Update READMEs (@xiazeyu)
-- [58453ec](https://github.com/EYHN/hexo-helper-live2d/commit/58453ecc0596ec964f5803167a4b194e239bddcc) 仅生成选择的模型(#14) 模型列表移除(#14) 请注意README中的路径要求！ (@xiazeyu)
-- [d5a6c9b](https://github.com/EYHN/hexo-helper-live2d/commit/d5a6c9b90f40c5bdb8e54af3fb15c26a08e3e8d4) Update READMEs (@xiazeyu)
-- [b3041f3](https://github.com/EYHN/hexo-helper-live2d/commit/b3041f3ae756e06368cb8782dd455ff82130e478) 增加模型左右设置(#10)(#19)(#21)(#23) 增加移动端模型更多功能(#12) (@xiazeyu)
-- [4a79abe](https://github.com/EYHN/hexo-helper-live2d/commit/4a79abe0f954e32d1064e25379ac479388b68758) Write new README (@xiazeyu)
-- [a992565](https://github.com/EYHN/hexo-helper-live2d/commit/a992565922e8c89671dd41e6f23491e61e43090a) Deleted package-lock.json to solve dependencies problems, and update hexo-fs to 0.2.2 (@xiazeyu)
-- [#26](https://github.com/EYHN/hexo-helper-live2d/pull/26) Tried to fix (#26) Uncaught TypeError (@xiazeyu)
-- [a189e38](https://github.com/EYHN/hexo-helper-live2d/commit/a189e38d456c28b0eb41ede3e8d981fcfc586cd3) 2.0.8 (@EYHN)
-- [#19](https://github.com/EYHN/hexo-helper-live2d/pull/19) Merge pull request #19 from xiazeyu/master (@xiazeyu)
-- [e622811](https://github.com/EYHN/hexo-helper-live2d/commit/e6228119973c058d003336477a19341798b6b29f) 更新依赖版本 (Issue #17 #18) (@xiazeyu)
-- [8e8540e](https://github.com/EYHN/hexo-helper-live2d/commit/8e8540ed7df0232837f8cdee6e1ba09c8035ed20) fix: tap point position (@EYHN)
-- [6dd0689](https://github.com/EYHN/hexo-helper-live2d/commit/6dd06898a7958f2df99885f1d06d96474332c677) fix: follow pointer not works (@EYHN)
-- [91d0e38](https://github.com/EYHN/hexo-helper-live2d/commit/91d0e38f193500db1714840f344cd571932cc9b7) 2.0.7 (@EYHN)
-- [4816b54](https://github.com/EYHN/hexo-helper-live2d/commit/4816b54b3a42a70cce6259119565c0b957f80961) fix: #16 (@EYHN)
-- [ae5cf70](https://github.com/EYHN/hexo-helper-live2d/commit/ae5cf709d244b7b22a9533bab809363e4c092141) Reduce the size of the  texture (@EYHN)
-- [ff7792a](https://github.com/EYHN/hexo-helper-live2d/commit/ff7792a43aacc3c1b2700065743975f240c274d2) docs: update readme (@EYHN)
-- [e1e53bb](https://github.com/EYHN/hexo-helper-live2d/commit/e1e53bb202f35daa73167fe80663bcae1aedad9d) docs: update readme (@EYHN)
-- [0a5aed4](https://github.com/EYHN/hexo-helper-live2d/commit/0a5aed48116e1882a85e6f7a0daed1f340acf4e1) doc(readme): add english version readme (@EYHN)
-- [50d8629](https://github.com/EYHN/hexo-helper-live2d/commit/50d86295a05b974e4c2c38f95c0043b4ae7180df) add english version readme (@gwzz)
-- [334cf4f](https://github.com/EYHN/hexo-helper-live2d/commit/334cf4fc9f1a8c7f6525452ff2d5144fced5ab26) readme (@EYHN)
-- [8289677](https://github.com/EYHN/hexo-helper-live2d/commit/8289677301fd8f7144da5276a9370f00cc7e6175) fix: mouseleave event (@EYHN)
-- [26b8179](https://github.com/EYHN/hexo-helper-live2d/commit/26b8179303a0473fba4ac33a81101bd9bfe128c7) feat: new models (@EYHN)
-- [02f4176](https://github.com/EYHN/hexo-helper-live2d/commit/02f4176c04ea55eed7b8c9ba5f7d75651e9706ef) fix: fix touch event (@EYHN)
-- [b122c3b](https://github.com/EYHN/hexo-helper-live2d/commit/b122c3b45ef92f2f2711d37ac09ad2330f4f8568) add demo (@EYHN)
-- [#4](https://github.com/EYHN/hexo-helper-live2d/pull/4) Merge pull request #4 from EYHN/dev (@EYHN)
-- [d3a2562](https://github.com/EYHN/hexo-helper-live2d/commit/d3a25624fed055f047f7bc3c12f84b5e398dbc37) readmd and license (@EYHN)
-- [3426e79](https://github.com/EYHN/hexo-helper-live2d/commit/3426e796ae6a671508cf1d67cd836089bb766f65) fix: script can't load (@EYHN)
-- [991d9aa](https://github.com/EYHN/hexo-helper-live2d/commit/991d9aa8c86b528c9fd9b29e78aa8f6368021c92) fix(helper): load url error (@EYHN)
-- [ab065c9](https://github.com/EYHN/hexo-helper-live2d/commit/ab065c95729f32e31720440363b9227b3caf5eb6) 2.0 resolve (@EYHN)
-- [0c16850](https://github.com/EYHN/hexo-helper-live2d/commit/0c16850ac9c97010ff765970f879f5722e8878fe) sreenshot (@EYHN)
-- [a6292a7](https://github.com/EYHN/hexo-helper-live2d/commit/a6292a7b399b3eef8e9df36f0f0fafd25ceff13b) z16 and readme (@EYHN)
-- [6eccd99](https://github.com/EYHN/hexo-helper-live2d/commit/6eccd992e41780ad85329a7058452253893bd802) new model (@EYHN)
-- [f5edfc2](https://github.com/EYHN/hexo-helper-live2d/commit/f5edfc2c2a2cc9c7356cecb1fd0560c28bc855b0) init (@EYHN)
+<a name="2.1.3"></a>
+## 2.1.3 (2017-11-14)
+
+
+### Bug Fixes
+
+* **helper:** load url error ([991d9aa](https://github.com/EYHN/hexo-helper-live2d/commit/991d9aa))
+* [#16](https://github.com/EYHN/hexo-helper-live2d/issues/16) ([4816b54](https://github.com/EYHN/hexo-helper-live2d/commit/4816b54))
+* bottomOffset to verticalOffset ([6d432b8](https://github.com/EYHN/hexo-helper-live2d/commit/6d432b8))
+* fix touch event ([02f4176](https://github.com/EYHN/hexo-helper-live2d/commit/02f4176))
+* follow pointer not works ([6dd0689](https://github.com/EYHN/hexo-helper-live2d/commit/6dd0689))
+* mouseleave event ([8289677](https://github.com/EYHN/hexo-helper-live2d/commit/8289677))
+* script can't load ([3426e79](https://github.com/EYHN/hexo-helper-live2d/commit/3426e79))
+* tap point position ([8e8540e](https://github.com/EYHN/hexo-helper-live2d/commit/8e8540e))
+
+
+### Features
+
+* new models ([26b8179](https://github.com/EYHN/hexo-helper-live2d/commit/26b8179))
+
+
+

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing
+
+## Issues
+
+Most of the time, if this plugin is not working correctly for you it is a simple configuration issue.
+
+**If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.**
+
+## Contributing directly to the source code
+
+**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) 
+
+See workflow for more information.
+
+## Submitting Changes
+
+After getting some feedback, push to your fork and submit a pull request. We
+may suggest some changes or improvements or alternatives, but for small changes
+your pull request should be accepted quickly.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* ~~[Write tests](./test/README.md)~~
+* Follow the existing coding style
+* Write a good commit message use `npm run commit`
+
+## Documentation
+
+Hexo-helper-live2d is insanely feature rich and documentation is a huge time sink. We
+greatly appreciate any time spent fixing typos or clarifying sections in the
+documentation.
+
+From opening a bug report to creating a pull request: every contribution is
+appreciated and welcome. If you're planning to implement a new feature or change
+the api please create an issue first. This way we can ensure that your precious
+work is not in vain.
+
+## Workflow
+
+### 1. Install environments
+
+- `npm run devenv`
+
+### 2. Make changes
+
+- `npm run build` to build client js files.
+
+- `npm run dev` to build client js files with debug files.
+
+### 3. Commit those changes
+
+- `npm run commit`, **Never use `git commit` again**
+
+### 4. Push the changes
+
+- `git push`
+
+### 5. ~~Make sure you passed the tests.~~
+
+- ~~`npm run test`~~
+
+### 6. Bump version in package.json
+
+### 7. Update Changelogs
+
+- `npm changelog`
+
+### 8. Commit package.json and CHANGELOG.md files
+
+### 9. Tag
+
+### 10. Push again
+
+- `git push`
+