About commitlint
A documentation-reference skill for commitlint, organized to help AI agents locate guidance by task. It covers setup, configuration, rules, APIs, concepts, troubleshooting, and examples for commitlint v21.2.3.
Key features
- 01Task-to-category documentation map
- 02Guides for installation and CI setup
- 03CLI options, configuration, and rules
- 04Node.js API and Conventional Commits references
- 05Troubleshooting and migration guidance
Use cases
- 01Find commitlint setup steps for a repository
- 02Look up rule settings or CLI options
- 03Check Node.js linting API usage
- 04Troubleshoot errors or plan an upgrade
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ fandhe-ai/ agent-reference-skills --skill commitlintAfter installing, type/commitlintin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/api/format.mdlint.mdload.mdread.mdREADME.mdreferences/concepts/commit-conventions.mdREADME.mdshareable-config.mdreferences/guides/ai-agents.mdci-setup.mdgetting-started.mdlocal-setup.mdREADME.mduse-prompt.mdreferences/reference/cli.mdcommunity-projects.mdconfiguration.mdexamples.mdplugins.mdprompt.mdREADME.mdrules-configuration.mdrules.mdreferences/support/README.mdreleases.mdtroubleshooting.mdupgrade.mdsamples/ci-github-actions.mdconfiguration-formats.mdcustom-rules.mdDetails
From the project READMEcommitlint リファレンス
commitlint 公式ドキュメントの全 API・ガイドを網羅したスキル。 ユーザーのタスクに応じて適切な README.md を読み、そこから個別ファイルへ辿ること。
対象 commitlint v21.2.3(Node.js >= 22.12.0 / git >= 2.13.2、v21.0.0 で最小 Node v22・入力表示形式変更)。
ディレクトリ構成
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 |
|---|---|---|
| インストール、初期設定、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 |
Comments
Markdown supported