Skip to content

Commitizen Types Guide

DupelaWebsite edited this page Sep 9, 2024 · 3 revisions

Commit Types Guide

npx git-cz
  • feat: A new feature for the user.
  • fix: A bug fix for the user.
  • docs: Documentation only changes.
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.).
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • perf: A code change that improves performance.
  • test: Adding missing or correcting existing tests.
  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs).
  • chore: Other changes that don't modify src or test files.
  • revert: Reverts a previous commit.

Scopes (Optional):

  • feat(auth): add login functionality

Write Descriptive Subject Lines:

  • feat(button): add disabled state
  • fix(auth): handle token expiration

Provide Detailed Bodies (Optional):

feat(auth): add OAuth2 support

This adds support for OAuth2 authentication, allowing users to log in
using their Google or Facebook accounts. This improves the user
experience and expands the range of supported login methods.

Add Breaking Changes (If Applicable):

feat(api): update endpoint to v2

BREAKING CHANGE: The endpoint `/api/v1/users` has been changed to
`/api/v2/users`. This change requires updating client applications
to handle the new endpoint format.

samples


feat(profile): add user avatar upload
fix(auth): correct token refresh logic
docs(readme): update installation instructions
refactor(user-service): simplify user validation logic
perf(database): optimize query performance
test(button): add unit tests for disabled state
chore(deps): update lodash to v4.17.21

Clone this wiki locally