commitlint

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

commitlint リファレンス

commitlint 参考手册

commitlint 公式ドキュメントの全 API・ガイドを網羅したスキル。ユーザーのタスクに応じて適切な README.md を読み、そこから個別ファイルへ辿ること。

本技能涵盖commitlint官方文档的所有API及指南。根据用户的任务需求读取合适的README.md，并由此跳转至对应文件查看详情。

ディレクトリ構成

目录结构

text

skills/commitlint/
  SKILL.md
  references/
    guides/
      README.md
      ai-agents.md
      ci-setup.md
      getting-started.md
      local-setup.md
      use-prompt.md
    reference/
      README.md
      cli.md
      community-projects.md
      configuration.md
      examples.md
      plugins.md
      prompt.md
      rules.md
      rules-configuration.md
    api/
      README.md
      format.md
      lint.md
      load.md
      read.md
    concepts/
      README.md
      commit-conventions.md
      shareable-config.md
    support/
      README.md
      releases.md
      troubleshooting.md
      upgrade.md
  samples/
    README.md
    getting-started.md
    local-setup-husky.md
    custom-rules.md
    shareable-config.md
    ci-github-actions.md
    configuration-formats.md
    validate-issue-reference.md
  scripts/
    README.md
    install.md
    setup.md
    cli.md
    validate.md
    prompt.md

text

skills/commitlint/
  SKILL.md
  references/
    guides/
      README.md
      ai-agents.md
      ci-setup.md
      getting-started.md
      local-setup.md
      use-prompt.md
    reference/
      README.md
      cli.md
      community-projects.md
      configuration.md
      examples.md
      plugins.md
      prompt.md
      rules.md
      rules-configuration.md
    api/
      README.md
      format.md
      lint.md
      load.md
      read.md
    concepts/
      README.md
      commit-conventions.md
      shareable-config.md
    support/
      README.md
      releases.md
      troubleshooting.md
      upgrade.md
  samples/
    README.md
    getting-started.md
    local-setup-husky.md
    custom-rules.md
    shareable-config.md
    ci-github-actions.md
    configuration-formats.md
    validate-issue-reference.md
  scripts/
    README.md
    install.md
    setup.md
    cli.md
    validate.md
    prompt.md

探索手順

探索步骤

タスクからカテゴリを引き、カテゴリの README.md で目的のページを特定する:

下記マッピング表でタスクに対応するカテゴリを探す
そのカテゴリの
```
references/{category}/README.md
```
を参照して目的のページを特定する
該当ページの
```
.md
```
を Read して詳細を確認する

根据任务确定对应类别，通过该类别的README.md定位目标页面：

从下方映射表中查找任务对应的类别
参考该类别下的
```
references/{category}/README.md
```
确定目标页面
读取对应页面的.md文件查看详细内容

タスク → カテゴリマッピング

任务 → 类别映射表

タスク	カテゴリ	参照 README
インストール、初期設定、Husky 連携、Git フック設定	guides	references/guides/README.md
CI 環境（GitHub Actions 等）での commitlint 設定	guides	references/guides/README.md
AI エージェント（Claude Code、Copilot、Cursor）との連携	guides	references/guides/README.md
対話型コミットメッセージ作成（prompt-cli）	guides	references/guides/README.md
CLI オプション、設定ファイル形式、全オプション	reference	references/reference/README.md
ルール一覧、ルール設定（Level / Applicable / Value）	reference	references/reference/README.md
プラグイン作成・登録	reference	references/reference/README.md
cz-commitlint プロンプト設定	reference	references/reference/README.md
@commitlint/lint, load, read, format の Node.js API	api	references/api/README.md
lint 結果のフォーマット・出力	api	references/api/README.md
Conventional Commits フォーマット、スコープの扱い	concepts	references/concepts/README.md
共有設定（shareable config）の作成・配布	concepts	references/concepts/README.md
エラー解決、よくある問題のトラブルシューティング	support	references/support/README.md
バージョンアップグレード、validate-commit-msg 移行	support	references/support/README.md
典型的な使い方・設定例を確認したい	samples	samples/README.md
インストール・CLI コマンド・検証コマンドを知りたい	scripts	scripts/README.md

任务	类别	参考README
安装、初始配置、Husky集成、Git钩子设置	guides	references/guides/README.md
CI环境（GitHub Actions等）中的commitlint配置	guides	references/guides/README.md
与AI Agent（Claude Code、Copilot、Cursor）的集成	guides	references/guides/README.md
交互式提交消息生成（prompt-cli）	guides	references/guides/README.md
CLI选项、配置文件格式、所有选项	reference	references/reference/README.md
规则列表、规则配置（Level / Applicable / Value）	reference	references/reference/README.md
插件创建与注册	reference	references/reference/README.md
cz-commitlint提示配置	reference	references/reference/README.md
@commitlint/lint、load、read、format的Node.js API	api	references/api/README.md
lint结果的格式与输出	api	references/api/README.md
Conventional Commits格式、范围处理	concepts	references/concepts/README.md
共享配置（shareable config）的创建与分发	concepts	references/concepts/README.md
错误解决、常见问题排查	support	references/support/README.md
版本升级、从validate-commit-msg迁移	support	references/support/README.md
查看典型用法与配置示例	samples	samples/README.md
了解安装、CLI命令、验证命令	scripts	scripts/README.md