# guandata-commit-format

> Guandata Tech team commit format

Latest version **0.0.3** (published 2019-05-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install guandata-commit-format
pnpm add guandata-commit-format
yarn add guandata-commit-format
bun add guandata-commit-format
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-05-27 |
| First published | 2019-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | stone |
| Maintainers | semix |

## Links

- npm: https://www.npmjs.com/package/guandata-commit-format
- npm.io page: https://npm.io/package/guandata-commit-format

## Dependencies (5)

- [longest](https://npm.io/package/longest.md) ^1.0.1
- [right-pad](https://npm.io/package/right-pad.md) ^1.0.1
- [word-wrap](https://npm.io/package/word-wrap.md) ^1.0.3
- [lodash.map](https://npm.io/package/lodash.map.md) ^4.5.1
- [current-git-branch](https://npm.io/package/current-git-branch.md) ^1.1.0

## Recent versions

- 0.0.3 (latest) — 2019-05-27
- 0.0.2 — 2019-05-27
- 0.0.1 — 2019-05-27
- 0.0.0 — 2019-05-24

## README

# guandata-commit-format

A tool to unify the commit format in your tech teams.

The result format of the commits looks like :
**TaskId CommitType: Subject**
> 
> T123 fix: Fix scrolling problem on android device

or just 

**CommitTypes: Subject**
> 
> feat: Implement the pipeline between hive and spark engine

After proper setup, this tool will prompt questions for you to answer, and thus guide you to build the commit string in either types of the above two.

`Setup`:

First off, you need install `commitizen`, both globally (for easy use of git-cz command) and project-wise

> npm install commitizen -g
> 
> npm install commitizen --save-dev

and then
> npm install guandata-commit-format --save-dev

and then let commitizen points to this tool,

> commitizen init guandata-commit-format --save-dev --save-exact

After all the above is done, you can use `git cz` to use this tool to help with your commit message. Meantime, you can still use `git commit` as usual.

`Credit`:

- For the 1st case, if you are happening on a git branch whose name includes the taskId (say, T3311-filter-design), you can just hit enter and let this tool to pick the task id for you.


- Based on the good work of 
[commitizen](https://github.com/commitizen/cz-cli) and [conventional changelog](https://github.com/stevemao/conventional-changelog-angular/blob/master/index.js).

---
_Source: https://npm.io/package/guandata-commit-format · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._