Skip to main content

Requirements

Requirements

Required Review

Prepare repository state, project files, templates, and staging expectations before creating a commit.

Commandcusty commit

Category

Git Operations

Quick Command

custy commit [OPTIONS]
requirementsGitstaging

Overview​

The commit profile reads and writes several project resources before creating Git history. Verify every required path and understand the working tree first.

Commit Requirements

Requirements

Git Repository

Required
Run the command inside the intended repository and branch.

Version File

Required
The configured project version file must exist and be writable.

Commit Template

Required
The configured commit-message template must exist and contain the intended message content.

Reviewed Working Tree

Required
Understand tracked, untracked, modified, staged, and deleted files before the staging step runs.

Interactive Editor

Recommended
Make the configured editor available when artifacts or message files require review.

Commitizen

Optional
Install custy[commitizen] only when the project requires Commitizen message validation or version strategy behavior. Auto mode otherwise uses Custy's built-in validator.

Recommended Preflight

Terminal
bash
git status
git diff
git diff --cached
custy --dry-run commit