1.4 KiB
1.4 KiB
Commit Conventions
This document outlines the commit message conventions to be followed for all changes within this project.
Conventional Commits
We follow the Conventional Commits specification to ensure clear and consistent commit messages.
- feat: A new feature. This is a new feature or a new capability.
- fix: A bug fix. This is a bug fix.
- chore: Routine tasks that don't change production code, such as build process updates, dependency updates, or other maintenance tasks.
- refactor: A code change that neither fixes a bug nor adds a feature. This is a code refactoring.
- docs: Changes to documentation only.
- style: Changes that do not affect the meaning of the code (white-space, formatting, semi-colons, etc).
- test: Adding missing tests 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).
- perf: A code change that improves performance.
Examples
feat
feat: Add user authentication endpoint
fix
fix: Resolve issue with login form validation
chore
chore: Update dependencies to latest versions
refactor
refactor: Improve error handling in data processing module
docs
docs: Update installation instructions
style
style: Format code according to Prettier standards