Skip to content

commit-message-schema.md

Latest commit

 

History

History
79 lines (60 loc) · 2.35 KB

commit-message-schema.md

File metadata and controls

79 lines (60 loc) · 2.35 KB

Commit Message Schema

This reference defines the reusable commit message schema enforced by src/validate.ts.

Required Sections

The validator requires the following sections:

Section Requirement
Subject <type>(<scope>): <subject> or <type>: <subject>
Why: Non-empty reason for the change
Impact: Non-empty user-visible effect, or None
Summary: A bullet list of high-level changes
Verification: A bullet list of checks and results
AI trailer One of AI-Agent:, AI-Generated:, or Co-developed-by:
Convention-Version: Date in YYYY-MM-DD format

Allowed Types

The validator accepts these commit types:

  • feat
  • fix
  • docs
  • refactor
  • test
  • chore
  • build
  • ci
  • perf
  • style
  • revert

Recommended Message

feat(commit): add AI-assisted commit checks

Why: AI-assisted changes need a repeatable review trail.
Impact: Maintainers can reject incomplete commit messages before review.

Summary:
- Add a reusable skill for preparing agent-made commits.
- Add a validator that enforces intent, impact, verification, and attribution.
- Add a local hook installer for commit-time enforcement.
- Add tests and fixtures for valid and invalid messages.

Verification:
- npm test passed.

AI-Agent: <agent-name> assisted with implementation and verification
Convention-Version: 2026-05-18

Project Overrides

Projects may tighten or loosen the schema via .commit-discipline.config.json.

Config Fields

Field Type Default Description
scan_staged boolean false Scan staged diff for secrets before validating
allow_merge_commits boolean true Skip validation for git-generated merge messages
allow_revert_commits boolean true Skip validation for git-generated revert messages
warn_only boolean false Exit 0 even on validation failure (warnings only)
output_json boolean false Output results as JSON
allowed_scopes string[] null Scope whitelist. null means any scope is allowed

CLI Flags

Flag Description
--json Output results as JSON
--install-hook Install commit-msg hook
--remove-hook Remove commit-msg hook
--version Print version
--help Show help