Commit Check Documentation

Welcome to the central documentation site for the Commit Check organization. Commit Check provides powerful tools for enforcing commit metadata standards across your development workflow.

🚀 Quick Start Guide

New to Commit Check? Get up and running in minutes with our Quick Start Guide.

Available Tools

Commit Check Tool

The main commit-check tool is a powerful command-line utility and pre-commit hook that enforces commit message formatting, branch naming, committer information, and more.

Features:

• Commit message validation (Conventional Commits support)
• Branch naming conventions
• Author name and email validation
• Commit signature verification
• Multiple integration options (CLI, pre-commit, Git hooks)

View Documentation →

Commit Check GitHub Action

A GitHub Action that brings commit-check validation directly to your CI/CD pipeline, with support for pull request comments and job summaries.

Features:

• Seamless GitHub integration
• Pull request validation
• Workflow job summaries
• Custom configuration support
• Works with fork repositories

View Documentation →

Quick Start

Using as GitHub Action

- uses: commit-check/commit-check-action@v1
  with:
    message: true
    branch: true
    author-name: true
    author-email: true

Using as CLI Tool

pip install commit-check
commit-check --message --branch --author-name --author-email

Using as Pre-commit Hook

- repo: https://github.com/commit-check/commit-check
  rev: main
  hooks:
    - id: check-message
    - id: check-branch

Getting Help

• Issues & Feature Requests: GitHub Issues
• Discussions: GitHub Discussions
• Source Code: GitHub Organization

License

All Commit Check tools are released under the MIT License.