git commit message convention

박마로·2022년 12월 5일
0
post-thumbnail

gitmoji

🎨 Improve structure / format of the codes.
⚡️ Improve performance.
🔥 Remove code or files.
🐛 Fix a bug.
🚑️ Critical hotfix.
✨ Introduce new features.
📝 Add or update documentation.
🚀 Deploy stuff.
💄 Add or Update the UI and style files.
🎉 Begin a Project
✅ Add, update, or pass tests.
🔒️ Fix security issues.
🔐 Add or update secrets.
🔖 Relase / Version tags.
🚨 Fix compiler / linter warning.
🚧 Work in progress.
💚 Fix CI build.
⬇️ Downgrade dependencies.
⬆️ Upgrade dependencies.
📌 Pin dependencies to specific versions.
👷 Add or update CI build system.
📈 Add or update analystics or track code.
♻️ Refactor code.
➕ Add a dependency.
➖ remove a dependency.
🔧 Add or update configuration files.
🔨 Add or update development scripts.
🌐 Internationalization and localization.


Commit Message Convention

type : subject

body

footer


Commit Type

feat : ✨
fix : 🐛
docs : 📝
style : 💄
refactor : ♻️
test : ✅
chore : 해당 커밋 타입의 어울리는 이모지 사용


예시

✨ : Implement login API

Client 에서 POST 방식으로 아이디와 패스워드를 Json Object 형식으로 전송하면 해당 데이터를 받아 member TABLE 에서 데이터 확인 후 성공시 200 코드와 JWT 토큰을 발급 이외의 경우 상황에 맞는 HTTP response status code를 리턴한다.

JWT, SPRING SECURITY 관련 커밋
Ref: #653d7e9d, #fb96c6fe

작성해봤는데.. 이렇게 작성하는게 맞는지..


Reference

gitmoji.dev
Git - 커밋 메시지 컨벤션

profile
Software Developer

0개의 댓글