commit-helper

Enforce conventional commits and pre-commit checks before Git commits.

1|3|Updated Sep 23, 2022
One-click install
npx skills add https://github.com/xxthunder/shortcuts --skill commit-helper-xxthunder
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-helper
Source: https://github.com/xxthunder/shortcuts/tree/main/.claude/skills/commit-helper
Command: npx skills add https://github.com/xxthunder/shortcuts --skill commit-helper-xxthunder

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Commit Helper guides developers to create conventional commits and ensures mandatory pre-commit checks are run before each commit, reducing integration issues and review overhead.

Core Features & Use Cases

  • Enforces Conventional Commits format, including allowed types such as feat, fix, docs, style, refactor, perf, test, chore.
  • Runs unit tests, integration tests (when applicable), and linting automatically before committing to ensure code quality.
  • Supports co-authoring with AI to credit contributions and improve collaboration.

Quick Start

Run the pre-commit suite before you commit to enforce checks and conventional-commit formatting

Frequently Asked Questions about commit-helper

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce conventional commits before a git commit is accepted?

To enforce conventional commits, the Skill validates commit messages against allowed types like feat, fix, docs, and refactor, and runs mandatory pre-commit checks before accepting the commit. This ensures format compliance and code quality.

Can I run linting and unit tests automatically before committing code?

Yes, you can run linting and unit tests automatically before committing code. The Skill triggers these pre-commit checks automatically to ensure code quality, running integration tests when applicable, to prevent integration issues.

What is the conventional commits format and when do I need it for my workflow?

The conventional commits format structures commit messages using specific types like feat, fix, docs, style, and chore. You need it in Git workflows and CI pipelines to standardize commit history, reducing review overhead and integration issues.

Does this pre-commit check tool work with CI pipelines and standard Git workflows?

Yes, this pre-commit check tool works with CI pipelines and standard Git workflows. It is designed for teams using Git and CI pipelines that require tests and linting prior to commit, ensuring code passes checks before integration.

How do I set up a SKILL.md file to start automating pre-commit checks?

To set up the automation, you need a SKILL.md file with YAML frontmatter containing at least a name and description. You may also reference optional resources in scripts/, references/, and assets/ directories as needed for your workflow.

Can I credit AI contributions using co-authoring in conventional commits?

Yes, you can credit AI contributions using co-authoring in conventional commits. The Skill supports co-authoring with AI to credit contributions accurately, which improves collaboration and maintains a clear history of AI-assisted code changes.