📝 fix(commit-types): add test documents

Author: arvinxx

packages/commit-types/CHANGELOG.md

@@ -1,17 +1 @@
 # 更新日志
-
-## @gitmoji/commit-types [1.1.4](https://github.com/arvinxx/commit-gitmoji/compare/@gitmoji/commit-types@1.1.3...@gitmoji/commit-types@1.1.4) (2021-01-25)
-
-
-### 🐛 Bug Fixes | 修复
-
-* **(Other)**: clean changelog ([8479426](https://github.com/arvinxx/commit-gitmoji/commit/8479426))
-* **(Other)**: link deps ([e4526ed](https://github.com/arvinxx/commit-gitmoji/commit/e4526ed))
-
-# [@gitmoji/commit-types-v1.1.3](https://github.com/arvinxx/commit-gitmoji/compare/@gitmoji/commit-types-v1.1.2...@gitmoji/commit-types-v1.1.3) (2021-01-25)
-
-
-### 🐛 Bug Fixes | 修复
-
-* clean changelog ([8479426](https://github.com/arvinxx/commit-gitmoji/commit/8479426))
-* link deps ([e4526ed](https://github.com/arvinxx/commit-gitmoji/commit/e4526ed))

packages/commit-types/README.md

@@ -0,0 +1,41 @@
+# @gitmoji/commit-types
+
+[![NPM version][type-image]][type-url] [![NPM downloads][download-image]][download-url] [![semantic-release][semantic-release]][semantic-release-repo] ![][license-url]
+
+Gitmoji styles Commit Types
+
+## Signature
+
+```typescript
+type CommitTypes =
+  | 'feat'           // Introducing new features
+  | 'fix'            // Fixing a bug
+  | 'refactor'       // Refactoring code (Not Introducing features or fix)
+  | 'docs'           // add documents
+  | 'test'           // Adding unit tests or e2e test
+  | 'perf'           // Improving performance
+  | 'revert'         // Reverting changes or commits
+  | 'style'          // Updating the UI and style files
+  | 'build'          // build artifacts
+  | 'ci'             // working about CI build system
+  | 'wip'            // Work in progress
+  | 'chore';         // Work with configuration or other stuff
+```
+
+[license-url]: https://img.shields.io/github/license/arvinxx/commit-gitmoji
+
+<!-- npm url -->
+
+[type-image]: http://img.shields.io/npm/v/@gitmoji/commit-types.svg?style=flat-square&color=deepgreen&label=latest
+[type-url]: http://npmjs.org/package/@gitmoji/commit-types
+[download-image]: https://img.shields.io/npm/dm/html2sketch.svg?style=flat-square
+[download-url]: https://npmjs.org/package/html2sketch
+
+<!-- semantic-release -->
+
+[semantic-release]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+[semantic-release-repo]: https://github.com/semantic-release/semantic-release
+
+## License
+
+[MIT](../../LICENSE) ® Arvin Xu