Skip to content

커밋 컨벤션

Jump to bottom
DaBin edited this page Jan 26, 2022 · 3 revisions

참고 : 4z7l의 GitCommitConvention, TeamCARDNA의 How to use Git

1. 기본

  • Commit Message는 한글로 작성하는 것을 원칙으로 하되, 의미 전달이 어려운 경우 영어를 사용한다.

2. My Git Commit Message Convention

  • FIX : 버그, 오류 해결
    [FIX] #10 - callback error

  • ADD : Feat 이외의 부수적인 코드 추가/라이브러리 추가/ 새로운 View나 Activity 생성
    [ADD] #11 - LoginActivity
    [ADD] #12 - CircleImageView Library

  • FEAT : 새로운 기능 구현
    [FEAT] #11 - google login

  • DEL : 쓸모없는 코드 삭제
    [DEL] #12 - unnecessary import package

  • DOCS : README나 wiki 등 개정
    [DOCS] #13 - update readme

  • REFACTOR : 내부 로직은 변경 하지 않고 기존의 코드 개선하는 리팩토링 시
    [REFACTOR] #15 - MVP architecture to MVVM

  • CHORE : 그 이외의 잡일/ 버전 코드 수정, 패키지 구조 변경, 파일 이동, 가독성이나 변수명, reformat 등
    [CHORE] #20 - delete unnecessary import package
    [CHORE] #21 - reformat MainActivity

  • MOD : xml 파일 수정 시
    [MOD] #30 - use constraintlayout in activity_main.xml

  • TEST : 테스트 코드 추가

ex)

[접두어] #이슈번호 - 내용<br>
세부내용<br>
각주<br>
[FEAT] #11 - google login

- Use Firebase Auth (http://example.com/reference)
- Need refactor code

See Also : #100, #120

⚙Setting

📚Rule

Clone this wiki locally