# @dgc-org/commitlint-config-conventional-changelog-for-jira 中文文档 规范地址：https://npmcn.com/package/%40dgc-org/commitlint-config-conventional-changelog-for-jira/ 版本：1\.2\.6 npm 元数据更新时间：2022-04-05T04:18:01.120Z 中文译文更新时间：2026-11-12T05:51:10.002Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40dgc-org/commitlint-config-conventional-changelog-for-jira 原文对照：https://npmcn.com/package/%40dgc-org/commitlint-config-conventional-changelog-for-jira/?lang=original 项目主页：https://github.com/cyberscan/commitlint-config-conventional-changelog-for-jira#readme 源码仓库：https://github.com/cyberscan/commitlint-config-conventional-changelog-for-jira ## 关键信息（来自 npm 元数据） - 包体积（解压后）：10.2 kB，5 个文件 - 模块格式：CommonJS - TypeScript 类型：未声明 - 运行依赖：1 个 - 首次发布：2021-06-09T15:35:10.298Z - 最新版本发布：2021-11-17T11:08:58.645Z - 近 30 天下载量：2788（2026-10-12 至 2026-11-10，npm 官方下载统计） - 已发布版本数：11（近 12 个月 0 个） ## 中文简介 共享承诺配置执行角承诺公约和Jira智能承诺 ## 安装 ```sh npm install @dgc-org/commitlint-config-conventional-changelog-for-jira ``` 也可以使用：`pnpm add @dgc-org/commitlint-config-conventional-changelog-for-jira`、`yarn add @dgc-org/commitlint-config-conventional-changelog-for-jira`、`bun add @dgc-org/commitlint-config-conventional-changelog-for-jira` ## README # 翻译: 可分享 `commitlint` 配置执行 [角质承诺公约](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) 财务报告和审定财务报表 [Jira 智能提交语法](https://support.atlassian.com/jira-software-cloud/docs/process-issues-with-smart-commits/)基于 [@ commitlint/ config- angular](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-angular#commitlintconfig-angular)。 。 。 . 使用方式 [翻译:](https://www.npmjs.com/package/@dgc-org/cz-conventional-changelog-for-jira), (中文(简体) ), [@ commitlint/ cli (中文(简体) )](https://www.npmjs.com/package/@commitlint/cli)。 。 。 . ## 开始 ```shell_session npm install --save-dev @dgc-org/commitlint-config-conventional-changelog-for-jira @commitlint/cli echo "module.exports = {extends: ['@dgc-org/commitlint-config-conventional-changelog-for-jira']};" > commitlint.config.js ``` ## 禁用承诺 在某些情况下,如果能够跳过闪烁,例如当无法进入Jira或不得不在GitOps做下流的事情时,也许有用。 如果满足了其中任一条件,此配置将完全跳过嵌入过程: - 提交信件开头 `WIP:`,比如说. `WIP: the office is burning down, need to save my work` - 环境变量 `COMMITLINT_DISABLE` 设置为 `true` (对大小写不敏感)或 `1` 这种机制只应在没有替代办法的情况下使用,而不应忽略可修复的验证故障. ## 规则 ### 问题 下述规则被认为是: `@dgc-org/commitlint-config-conventional-changelog-for-jira` 并在未满足时生成非零退出代码. 咨询 [文件/规则](https://conventional-changelog.github.io/commitlint/#/reference-rules) 用于列出现有规则. #### 类型 - **条件**数字 : `type` 以数值显示 - **规则**数字 : `always` - **价值** ```shell_session [ "feat", "fix", "docs", "refactor", "test", "style", "build", "ci", "chore", "revert", "perf", "wip", ] ``` ```shell_session echo "foo: some message" # fails echo "fix: some message" # passes ``` #### 类型大小写 - **说明**数字 : `type` 发生时 `value` - **规则**数字 : `always` - **价值** ```shell_session 'lowerCase' ``` ```shell_session echo "FIX: some message" # fails echo "fix: some message" # passes ``` #### 类型空 - **条件**数字 : `type` 为空 - **规则**数字 : `never` ```shell_session echo ": some message" # fails echo "fix: some message" # passes ``` #### 范围 - **条件**数字 : `scope` 发生时 `value` - **规则**数字 : `always` ```shell_session 'lowerCase' ``` ```shell_session echo "fix(SCOPE): some message" # fails echo "fix(scope): some message" # passes ``` #### 主题 - **条件**数字 : `subject` 在其中一种情况下 `['sentence-case', 'start-case', 'pascal-case', 'upper-case']` - **规则**数字 : `never` ```shell_session echo "fix(SCOPE): Some message" # fails echo "fix(SCOPE): Some Message" # fails echo "fix(SCOPE): SomeMessage" # fails echo "fix(SCOPE): SOMEMESSAGE" # fails echo "fix(scope): some message" # passes echo "fix(scope): some Message" # passes ``` #### 主题空出 - **条件**数字 : `subject` 为空 - **规则**数字 : `never` ```shell_session echo "fix:" # fails echo "fix: some message" # passes ``` #### 主题全站 - **条件**数字 : `subject` 结尾 `value` - **规则**数字 : `never` - **价值** ```shell_session '.' ``` ```shell_session echo "fix: some message." # fails echo "fix: some message" # passes ``` #### 头-最大长 - **条件**数字 : `header` 已经 `value` 或小于字符 - **规则**数字 : `always` - **价值** ```shell_session 72 ``` ```shell_session echo "fix: some message that is way too long and breaks the line max-length by several characters" # fails echo "fix: some message" # passes ``` ### 警告 以下规则被视为警告 `@dgc-org/commitlint-config-conventional-changelog-for-jira` 当警告未满足时,将打印它. #### 身体领先 - **条件**: 以空白行开头的正文 - **规则**数字 : `always` ## 常见问题 ### @dgc-org/commitlint-config-conventional-changelog-for-jira 是什么？ 共享承诺配置执行角承诺公约和Jira智能承诺 ### 如何安装 @dgc-org/commitlint-config-conventional-changelog-for-jira？ 在项目目录运行 npm install @dgc-org/commitlint-config-conventional-changelog-for-jira，或使用 pnpm add / yarn add / bun add。 ### @dgc-org/commitlint-config-conventional-changelog-for-jira 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/dgc-org\_\_commitlint-config-conventional-changelog-for-jira 是否存在。 ### @dgc-org/commitlint-config-conventional-changelog-for-jira 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @dgc-org/commitlint-config-conventional-changelog-for-jira 可以商用吗？ @dgc-org/commitlint-config-conventional-changelog-for-jira 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @dgc-org/commitlint-config-conventional-changelog-for-jira 的下载量有多少？ 根据 npm 官方下载统计，@dgc-org/commitlint-config-conventional-changelog-for-jira 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,788 次，日均约 93 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @dgc-org/commitlint-config-conventional-changelog-for-jira 还在维护吗？ 最新版本 1\.2\.6 发布于 2021/11/17（4 年前）；至今共发布 11 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/06/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。