Zhengqbbb / cz-git

cz-git | czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI
https://cz-git.qbb.sh
MIT License
1.05k stars 39 forks source link

[Bug report] 网站文档描述是否不当? #168

Closed you-hengh closed 5 months ago

you-hengh commented 5 months ago

✅ Checklist

📄 System Info

System:
    OS: Windows 11 10.0.22631
    CPU: (20) x64 13th Gen Intel(R) CoreT i7-13800H
    Memory: 21.91 GB / 31.74 GB
  Binaries:
    Node: 20.11.1 - ~\AppData\Local\pnpm\node.EXE
    npm: 10.2.4 - ~\AppData\Local\pnpm\npm.CMD
    pnpm: 8.15.4 - ~\AppData\Local\pnpm\pnpm.EXE
  npmPackages:
    commitizen: ^4.3.0 => 4.3.0

🔎 Description

Concise Description

https://cz-git.qbb.sh/zh/config/engineer#maxheaderlength 在这里, 网站描述为定义commit message中的 header 长度, 但据我查看message节点,根本没有所谓header, 只有subjectbody

Expected behavior

应当修正maxheaderlengthmaxSubjectLength, 描述为定义commit message中的 subject 长度

应当修正原maxSubjectLengthmaxBodyLength,描述为定义commit message中的 body 长度

Screenshots or Screen Recording(if possible)

image

顺便说一下 在提交过程中, 填写"body": "填写更加详细的变更描述(可选)。使用 \"|\" 换行:",的内容时,没有出现限制字符的提示,是否需要完善一下?

🔗 Reproduction link / repo:

No response

Zhengqbbb commented 5 months ago

header = type (类型) + scope (范围) + subject (简短描述)


顺便说一下 在提交过程中, 填写"body": "填写更加详细的变更描述(可选)。使用 \"|\" 换行:",的内容时,没有出现限制字符的提示,是否需要完善一下?

不,我们遵循标准的 Conventional Commits 规范。body 详细描述 不设有字数限制