create-commit-message

Writing Commit Messages With Convention Commit

All commit messages follow Conventional Commits standard when generating or suggesting commit messages.

Format

<type>(<scope>): <description>

• Type: Defines the nature of the change.
• Scope: Prefer domain- or module-level identifiers, not file names. Reflects logical grouping or feature boundary, not precise file paths.
• Description: Written in imperative mood. One sentence.

Types

• feat: A new feature.
• fix: A bug fix.
• docs: Documentation changes only.
• style: Code formatting, no logic change.
• refactor: Code restructuring, no behavior change.
• perf: Performance improvements.
• test: Adding or improving tests.
• chore: Build process, dependencies, or auxiliary tools.
• ci: CI/CD config or script changes.
• build: Affects the build system or external dependencies

---

Examples

Example A (Change History)

Staged Changes:

• Created a new file named src/auth/login.ts
• Imported src/auth/login.ts into src/users/account.ts
• Added a modal component class named 'loginForm'
• Tracked a new test file named test/login.test.ts
• Git dif of the documentation shows a new section named "# Logging In"

Output 1 (GOOD):

feat(users-account): add user authentication

Output 2 (BAD):

// No past tense. No periods at the end of the message. No file names for scope
feat(users-account.ts): added user authentication.

Example B (Change History)

Staged Changes:

• Created validation schema in src/validation/product-schema.ts using Zod
• Integrated schema into product API endpoint in src/routes/products.ts
• Added unit tests in test/validation/product-schema.test.ts

Output 4 (GOOD):

feat(product-schema): add zod schema validation for product input

Output 4 (BAD):

// Avoid PascalCase. Avoid file extensions. Avoid stating the file path or using vague verbs.
feat(ProductSchema.ts): created validation for product input