Summary¶
Conventional Commit, yazılan commit mesajlarının belli bir formata uygun olmasını sağlayan bir standarttır. Bu standart, proje geçmişini daha okunabilir ve düzenli hale getirmeyi; otomasyon süreçlerinde (sürüm numaralandırma, changelog oluşturma vb.) daha kolay entegrasyon sunmayı amaçlar. Conventional Commit kullanarak, commit mesajları daha anlamlı olur ve ekip içi iletişim daha etkin hale gelir.
Bir commit mesajı genellikle şu formatta olmalıdır:
type(scope): short description
[optional] detail description
Burada "tip" commit'in amacını belirtir ve aşağıdaki örneklerden biri olabilir:
- feat: Yeni bir özellik eklemek için kullanılır.
- fix: Bir hatayı düzeltmek için kullanılır.
- docs: Dökümanla ilgili değişiklik yapmak için kullanılır.
- style: Kod formatlama, beyaz alan, noktalama gibi düzenlemeler için kullanılır.
- refactor: Kodda yapısal değişiklik yapmak ama işleyişi değiştirmemek için kullanılır.
- test: Testlerle ilgili değişiklik yapmak için kullanılır.
- chore: Yapı, araçlar ya da kütüphanelerle ilgili işler için kullanılır.
Kısa commit mesaj örnekleri
feat: Added profile editing page for users
fix: Fixed form validation error on login page
fix(api): correct error handling in user registration
docs: Added new section to the user guide
feat(user-profile): remove support for legacy profile pictures
feat(db): add migration script for new user roles
chore: initialize project with basic setup
chore(deps): update dependencies to latest versions
chore(build): update webpack configuration for production
test(auth): add unit tests for login component
perf(cache): improve response time by caching user data
refactor(database): optimize query for user search
style(css): apply consistent spacing in header styles
docs(readme): update installation instructions
Detaylı commit mesaj örnekleri
feat(api)!: migrate to new authentication protocol
BREAKING CHANGE: Old authentication endpoints have been removed. Please use the new OAuth2-based system.
📢 Eğer "Braking Change" var ise tip sonrasından ! kullanılır.
Daha detaylı bilgi için Conventional Commits resmi dokümantasyonuna bakabilirsiniz.