Skip to content

README.md

Latest commit

 

History

History
22 lines (18 loc) · 2.16 KB

README.md

File metadata and controls

22 lines (18 loc) · 2.16 KB
Raw

Git Commit Message Keywords

When contributing to any project, use the following keywords in your commit messages to clearly indicate the type of change being made:

  • feat: Introduces a new feature. Example: feat: Add user authentication
  • fix: Addresses a bug or issue. Example: fix: Resolve issue with broken link on homepage
  • style: Changes the code style or formatting (no functional changes). Example: style: Enforce consistent indentation across codebase
  • refactor: Improves code structure or organization without adding features or fixing bugs. Example: refactor: Extract database connection logic into separate module
  • add: Creates a new capability (feature, test, dependency, etc.). Example: add: Implement unit tests for data validation
  • drop: Removes a capability (feature, test, dependency, etc.). Example: drop: Remove unused analytics library
  • bump: Increases the version of a dependency or tool. Example: bump: Upgrade React version to 18.2
  • make: Changes to the build process, tools, or infrastructure. Example: make: Update webpack configuration for production builds
  • start: Begins a process or enables a feature (e.g., a toggle or feature flag). Example: start: Enable new payment processing system
  • stop: Ends a process or disables a feature (e.g., a toggle or feature flag). Example: stop: Disable deprecated API endpoint
  • optimize: A performance-focused change that improves speed or efficiency. Example: optimize: Improve query performance for user profiles
  • document or docs: Changes related solely to documentation. Example: docs: Update API documentation for new endpoint
  • chore: General maintenance tasks, dependency upgrades, etc. Example: chore: Update dependencies to latest versions
  • test: Changes related to adding or correcting tests. Example: test: Add integration tests for payment processing

Linking to Issues/Work Items:

If your commit relates to a specific issue or work item in the tracking system, include the issue ID in the commit message (e.g., fix: Resolve issue #123 - User profile update error).