A skill covering all APIs and guides of the official commitlint documentation. Depending on the user's task, read the appropriate README.md and follow it to the individual files.
Directory structure
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
Exploration procedure
Derive the category from the task, and identify the target page in the category's README.md:
- Find the category corresponding to the task in the mapping table below
- For that category,
references/{category}/README.mdRefer to and identify the target page - Read the
.mdof the relevant page to check the details
Task → Category Mapping
| Task | Category | Reference README |
|---|---|---|
| Installation, initial setup, Husky integration, Git hook configuration | guides | references/guides/README.md |
| Configuring commitlint in CI environments (GitHub Actions, etc.) | guides | references/guides/README.md |
| Integration with AI agents (Claude Code, Copilot, Cursor) | guides | references/guides/README.md |
| Interactive commit message creation (prompt-cli) | guides | references/guides/README.md |
| CLI options, configuration file formats, all options | reference | references/reference/README.md |
| Rule list, rule configuration (Level / Applicable / Value) | reference | references/reference/README.md |
| Creating and registering plugins | reference | references/reference/README.md |
| cz-commitlint prompt configuration | reference | references/reference/README.md |
| @commitlint/lint, load, read, format の Node.js API | api | references/api/README.md |
| Formatting and outputting lint results | api | references/api/README.md |
| Conventional Commits format, handling of scopes | concepts | references/concepts/README.md |
| Creating and distributing shareable configs | concepts | references/concepts/README.md |
| Error resolution, troubleshooting common problems | support | references/support/README.md |
| Version upgrades, migrating from validate-commit-msg | support | references/support/README.md |
| Want to check typical usage and configuration examples | samples | samples/README.md |
| Want to know about installation, CLI commands, and validation commands | scripts | scripts/README.md |