Introduction

In software development, maintaining a clear and consistent style for commit messages is essential for effective collaboration and code management. Below are guidelines for different categories of commit messages, each with a specific purpose and format.


Commit Message Conventions

Addition of New Features or Files 

Added: Added user authentication module

New File: Added README.md

Removal of Features or Files 

Deleted: Deleted old API endpoints

Remove: Dropped support for deprecated API version

Modifications or Improvements

Minor Adjustments or Enhancements 

Adjusted: Margin in header section for better alignment

Modified: Updated CSS styles for mobile responsiveness

Patch: Corrected typo in variable name

Performance or Efficiency Improvements 

Optimize: Reduced image loading times by using compressed formats

Code Refactoring Without Changing Functionality 

Refactor: Reorganized user service methods for better readability

Making Code or Documentation Consistent 

Standardize: Applied consistent naming conventions across modules

Code Style Changes (Without Impacting Functionality) 

Style: Formatted code according to ESLint rules

Bugfixes and Critical Solutions

Fixing a Specific Bug 

Bugfix: Corrected error handling in login form

Fix: Resolved issue with user profile loading

Urgent Fix for a Critical Production Issue 

Hotfix: Fixed production crash when loading large datasets

A Quick Bugfix That Has Not Been Fully Tested 

Coldfix: Temporary fix for navbar rendering issue

Security and Tests

Resolving Security Issues 

Security: Fixed vulnerability in user authentication

Adding or Modifying Test Cases 

Test: Added unit tests for login component

Maintenance and Documentation

Maintenance Tasks Without Functional Impact 

Chore: Updated dependencies and cleaned up logs

Code Cleanup Without Functional Changes 

Cleanup: Removed unused variables and redundant code

Adding Documentation or Comments 

Note: Added explanation for caching mechanism in comments

Docs: Updated API documentation with new endpoints

Version Control and Reversions

Bumping a Version or Updating a Dependency 

Bump: Bumped version from 2.0.0 to 2.0.1

Reverting to a Previous Stable Version 

Roll Back: Reverted to version 1.4.0 due to instability

Undoing or Reversing a Commit 

Revert: Reverted commit 123456a

Reversed: Undid changes from commit 123456a

Preparation and Staging

Preparing Changes for a Commit 

Staged: Prepared updates for new release
Edit this page

Last updated 22 Sep 2024, 12:15 CEST . history