commitizen / commitizen/cz-cli

[Feature] combination of "cz-conventional-changelog" with "@commitlint/prompt"

未關閉
#593 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
JavaScript
星號
17.5k
分支
566
平均合併
8 小時 16 分鐘
30 天內合併 PR
1

描述

## Question

> How to use "cz-conventional-changelog" and "@commitlint/prompt" together?

See details from https://github.com/marionebl/commitlint/issues/512

## Current configuration confliction

Default to
```js
...
"config": {
"commitizen": {
"path": "cz-conventional-changelog"
}
}
```

`commitizen` provides us with a way to automatically generate the changelog. However, it prompt is not convenient when used in daily work. I prefer to use a commitment adaptor like the following

```js
"config": {
"commitizen": {
"path": "@commitlint/prompt"
}
}
```

## Expected Behavior

```js

"config": {
"commitizen": {
"path": ["cz-conventional-changelog","@commitlint/prompt"]
}
}
```

## Current behavior

```bash
➜ topology git:(master) ✗ npm run git:commit

> nio_hdmap_topology@1.0.0 git:commit /Users/lei.wang1/Github/nio-common/topology
> git-cz && ./node_modules/validate-commit-msg/lib/cli.js

The "path" argument must be of type string. Received type object
```

貢獻指南

開啟貢獻指南

研究方向

先閱讀 commitizen 設定對路徑的處理方式,並重現報告中顯示的 git-cz 指令,接著檢視連結的 commitlint issue 以了解相容性背景。當某個設定能夠將 cz-conventional-changelog 與 @commitlint/prompt 結合使用而不產生路徑類型錯誤,並保留預期的每日 prompt 工作流程時,即視為完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
javascript, nodejs
領域
cli
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。