Conventional Commits
This document outlines the common types of commits following the Conventional Commits standard, along with examples of each type.
feat - Features
A new API or behavior for the end user.
| Example Commit Message | Branch |
|---|---|
| This PR allow users to upload profile pictures. | feat/upload-profile-pictures |
| This PR add user authentication module. | feat/add-user-authentication |
| This PR implement dark mode toggle. | feat/dark-mode-toggle |
| This PR create dashboard for user analytics. | feat/user-analytics-dashboard |
| This PR enable social media login options. | feat/social-media-login |
fix - Bug Fixes
A bug fix for the end user.
| Example Commit Message | Branch |
|---|---|
| This PR resolve mobile login button click issue. | fix/mobile-login-issue |
| This PR correct typo in homepage header. | fix/homepage-header-typo |
| This PR prevent crash when accessing profile page. | fix/profile-page-crash |
| This PR fix broken image links in gallery. | fix/gallery-image-links |
| This PR resolve incorrect calculation in checkout. | fix/checkout-calculation |
docs - Documentation
A change to the website or other Markdown documents in our repo.
| Example Commit Message | Branch |
|---|---|
| This PR update installation guide with troubleshooting steps. | docs/update-installation-guide |
| This PR add installation instructions to README. | docs/add-installation-instructions |
| This PR clarify contribution guidelines. | docs/clarify-contribution-guidelines |
| This PR create a changelog for version history. | docs/create-changelog |
| This PR add onboarding screenshots. | docs/add-onboarding-screenshots |
refactor - Refactoring
A change to production code that leads to no behavior difference.
| Example Commit Message | Branch |
|---|---|
| This PR streamline user profile loading logic. | refactor/user-profile-loading |
| This PR extract common utility functions. | refactor/extract-utility-functions |
| This PR reorganize state management for better performance. | refactor/state-management |
| This PR simplify component structure for the header. | refactor/header-component |
| This PR consolidate duplicate API requests. | refactor/consolidate-api-requests |
test - Tests
Adding missing tests, refactoring tests; no production code change.
| Example Commit Message | Branch |
|---|---|
| This PR add unit tests for user service. | test/user-service |
| This PR improve coverage for login component. | test/login-component-coverage |
| This PR write integration tests for payment processing. | test/payment-processing |
| This PR validate error handling in API responses. | test/api-error-handling |
| This PR add snapshot tests for UI components. | test/ui-snapshot-tests |
chore - Chores
Upgrading dependencies, releasing new versions, maintenance tasks.
| Example Commit Message | Branch |
|---|---|
| This PR update package.json with latest dependency versions. | chore/update-dependencies |
| This PR clean up unused CSS styles. | chore/cleanup-css |
| This PR migrate build tool from Gulp to Webpack. | chore/migrate-to-webpack |
| This PR remove deprecated API endpoints. | chore/remove-deprecated-apis |
| This PR reorganize project structure for clarity. | chore/reorganize-project-structure |
misc - Miscellaneous
Anything else that doesn't change production code, yet is not test or chore.
| Example Commit Message | Branch |
|---|---|
| This PR update GitHub Actions workflow to include code linting. | misc/update-github-actions |
| This PR update package-lock.json to reflect latest npm version. | misc/update-package-lock |
| This PR modify .gitignore to exclude unnecessary files. | misc/modify-gitignore |
| This PR add README section for debugging setup. | misc/add-debugging-section |
| This PR remove old testing configuration files. | misc/remove-old-configs |