@gitmoji/commit-types/README.md

gitmoji styles commit types

# @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