-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Commit Message Prefixes
Most prevalent that I'll use
-
feat:
— A new feature or enhancement
Example:
feat: add user authentication
-
fix:
— A bug fix
Example:
fix: correct login issue
-
docs:
— Documentation changes
Example:
docs: update API usage examples
-
refactor:
— Code changes that neither fix a bug nor add a feature, but improve the structure
Example:
refactor: simplify login function
-
format:
— Applying code formatting tools
Example:
format: run Prettier on codebase
Full list
-
feat:
— A new feature or enhancement
Example:
feat: add user authentication
-
fix:
— A bug fix
Example:
fix: correct login issue
-
docs:
— Documentation changes
Example:
docs: update API usage examples
-
style:
— Code style changes (formatting, missing semicolons, etc.)
Example:
style: format code with Prettier
-
refactor:
— Code changes that neither fix a bug nor add a feature, but improve the structure
Example:
refactor: simplify login function
-
perf:
— Performance improvements
Example:
perf: optimize data processing algorithm
-
test:
— Adding or modifying tests
Example:
test: add unit tests for user module
-
chore:
— Routine tasks and maintenance (e.g., build process, dependencies)
Example:
chore: update dependencies
-
build:
— Changes to the build process or external dependencies
Example:
build: update webpack configuration
-
ci:
— Continuous integration changes (e.g., configuration files, scripts)
Example:
ci: update GitHub Actions workflow
-
revert:
— Reverting a previous commit
Example:
revert: undo changes in commit abc123
-
merge:
— Merging branches (used to describe the merge commit)
Example:
merge: merge feature branch into main
-
cleanup:
— Removing unused or redundant code
Example:
cleanup: remove obsolete code
-
format:
— Applying code formatting tools
Example:
format: run Prettier on codebase