Skip to content

Git Commit Standards

CleanSlice follows Conventional Commits for consistent, meaningful commit history.

Format

<type>: <description>

Keep commits short and simple. One line is enough for most commits.

Commit Types

TypeDescriptionVersion Bump
featNew featureMINOR (1.x.0)
fixBug fixPATCH (1.0.x)
docsDocumentation only
refactorCode change (no feature or fix)
testAdding or updating tests
choreMaintenance tasks

Rules

  1. Use lowercase for the description
  2. No period at the end
  3. Use imperative mood ("add" not "added")
  4. Keep under 72 characters

Examples

feat: add user authentication
fix: resolve login timeout issue
docs: update API documentation
refactor: simplify validation logic
test: add unit tests for user gateway
chore: update dependencies

Breaking Changes

Add ! after the type to indicate a breaking change:

feat!: change response format
fix!: remove deprecated API endpoint

Breaking changes trigger a MAJOR version bump (x.0.0).

Versioning

Follows Semantic Versioning:

  • fix → PATCH (1.0.0 → 1.0.1)
  • feat → MINOR (1.0.0 → 1.1.0)
  • ! (breaking) → MAJOR (1.0.0 → 2.0.0)

Built with CleanSlice