Skip to content

Commit Convention

This repository follows a simplified Conventional Commits format.

Format

<type>: <summary>

<type>(<scope>): <summary>

Scopes are optional and should only be used when they add useful context.

Types

feat

Introduces a new feature or capability.

Examples

feat: add XXMiddleware

fix

Fixes a bug or incorrect behavior.

Examples

fix: prevent duplicate request log

refactor

Changes code structure without changing behavior.

Examples

refactor: simplify logging clearance

perf

Improves performance without changing functionality.

Examples

perf: reduce something to improve performance

test

Adds, updates, or fixes automated tests.

Examples

test: improve coverage for middleware

docs

Documentation only changes.

Examples

docs: update development setup guide

style

Formatting and code style changes that do not affect functionality.

Examples

style: apply code formatting

build

Changes related to build systems, packaging, or dependency management configuration.

Examples

build: migrate to uv

ci

Changes to CI/CD pipelines and automation workflows.

Examples

ci: add test workflow

chore

Repository maintenance and housekeeping tasks.

This type is commonly used for dependency updates.

Examples

chore: clean up unused scripts

revert

Reverts a previous commit.

Examples

revert: revert "feat: add social login"