Skip to content

Instantly share code, notes, and snippets.

@0xAungkon
Last active January 18, 2025 10:35
Show Gist options
  • Select an option

  • Save 0xAungkon/690a23fafa620265c92d2fe44216d462 to your computer and use it in GitHub Desktop.

Select an option

Save 0xAungkon/690a23fafa620265c92d2fe44216d462 to your computer and use it in GitHub Desktop.
Git Standard Commit Message Best Practice Example Correct

Here’s a detailed table of enterprise-grade examples for Git commit messages tailored for large-scale solutions, considering high collaboration, scalability, and maintainability:

Type Description (When to Use) Commit Message Example
feat For introducing a new feature with clear business value. feat: implement multi-tenant support for enterprise clients
fix For resolving critical bugs or production issues. fix: address race condition in payment processing workflow
docs For updating documentation critical for team onboarding or feature usage. docs: add API versioning details to the developer guide
style For enforcing coding standards across the enterprise solution. style: apply consistent code formatting across modules using ESLint
refactor For improving code structure without impacting external behavior. refactor: modularize user authentication service for better scalability
test For enhancing test coverage or adding critical tests for production-ready features. test: add integration tests for multi-region data replication
chore For updating dependencies or performing tasks unrelated to user-facing functionality. chore: upgrade Node.js version to LTS for improved security
ci For improving CI/CD pipelines critical for automated testing and deployment in large setups. ci: add automated rollback on deployment failure in Jenkins pipeline
perf For making optimizations that improve system performance or scalability. perf: optimize Redis caching for faster session retrieval under high load
build For changes to build systems or external integrations in enterprise contexts. build: update Maven configuration to support enterprise SSO integration
security For patches addressing security vulnerabilities. security: fix SQL injection vulnerability in report generation API
hotfix For urgent fixes to production issues requiring immediate attention. hotfix: resolve service downtime caused by faulty load balancer configuration

This structure ensures clear communication, compliance with industry standards, and seamless collaboration across large, distributed teams.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment