그동안 나는 git에 commit message를 대충 아무거나 작성해서 올리곤 하였다.
하지만 나 혼자 작업하는 것이 아닌 실무에서 여러사람과 함께 작업할 때에는 commit message도 잘 쓰는것이 중요한 것 같아 기본적으로 많이들 아는 명령문으로 작성하는 것 외에 어떠한 규칙들이 있는지 공부하게 되었다.
좋은 Commit message를 위한 규칙
1. 제목과 본문을 빈 행으로 구분한다
2. 제목 첫글자는 대문자로 작성
3. 제목 끝에 마침표(.) 넣지 않기
4. 제목은 명령문 으로 사용하며 과거형을 사용하지 않는다
5. 본문의 각 행은 72글자 내로 제한
6.제목을 50글자 내로 제한
7. 어떻게 보다는 무엇과 왜를 설명한다
Commit 유형 지정
- FEAT : 새로운 기능의 추가
- FIX: 가장 자주 사용되는 커밋 로그 중 하나로 보통 올바르지 않은 동작을 고친 경우에 사용
- DOCS: 문서 수정
- STYLE: 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
- REFACTOR: 코드 리펙토링
- TEST: 테스트 코트, 리펙토링 테스트 코드 추가
- CHORE: 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)
많이 쓰이는 영어단어 목록
[ADD]
코드나 테스트, 예제, 문서 등의 추가가 있을 때 사용한다
- Add A for B
B를 위해 A를 추가했습니다 - Add A to B
B에 A를 추가했습니다
[REMOVE]
코드의 삭제가 있을 때 사용한다. ‘Clean’이나 ‘Eliminate’를 사용하기도 한다. 보통 A 앞에 ‘unnecessary’, ‘useless’, ‘unneeded’, ‘unused’, ‘duplicated’가 붙는 경우가 많다.
[USE]
특별히 무언가를 사용해 구현을 하는 경우이다.
-
Use A for B
B에 A를 사용합니다 -
Use A to B
B가 되도록 A를 사용합니다 -
Use A in B
B에서 A를 사용합니다 -
Use A instead of B
B 대신 A를 사용합니다
[REFACTOR]
전면 수정이 있을 때 사용한다.
- Refactor A
[SIMPLIFY]
복잡한 코드를 단순화 할 때 사용한다. Refactor의 성격이 강하나 이보다는 약한 수정의 경우 이용하면 좋다.
- Simplify A
A를 단순화합니다
[UPDATE]
개정이나 버전 업데이트가 있을 때 사용힌다. Fix와는 달리 Update는 잘못된 것을 바로잡는 것이 아니라는 점에 주의해야 한다. 원래도 정상적으로 동작하고 있었지만, 수정, 추가, 보완을 한다는 개념이다. 코드보다는 주로 문서나 리소스, 라이브러리등에 사용합니다.
- Update A to B
A를 B로 업데이트 합니다.
[MAKE]
주로 기존 동작의 변경을 명시한다.
- Make A B
A를 B하게 만듭니다
새롭게 뭔가를 만들었을 때는 Make 대신, Add를 사용해야 한다.
[IMPLEMENT]
코드가 추가된 정도보다 더 주목할 만한 구현체를 완성시켰을 때 사용한다.
-
Implement A
A를 구현합니다
‘Add’에 비해 더 큰 단위의 코드 추가에 사용되며, 특히 모듈이나 클래스 등의 단위에 사용되기 때문에 특별히 목적을 부여 해주지 않아도 되는 경우가 많다. 따라서 ‘Add’에 비해 to나 for가 함께 사용되는 경우가 적습니다. -
Implement A to B
B를 위해 A를 구현합니다
구현 목적을 설명할 필요가 있을 때에는 ‘to’를 사용합니다.
[CORRECT]
주로 문법의 오류나 타입의 변경, 이름 변경 등에 사용한다.
- Correct A
A를 고칩니다
[PREVENT]
특정한 처리를 못하게 막는다
-
Prevent A
A하지 못하게 막습니다 -
Prevent A from B
A를 B하지 못하게 막습니다
[MOVE]
코드의 이동이 있을 때 사용한다.
- Move A to B, Move A into B
A를 B로 옮깁니다
[VERIFY]
검증 코드를 넣을 때 주로 사용한다.
- Verify A
A를 검증합니다
[SET]
변수 값을 변경하는 등의 작은 수정에 주로 사용한다.
- Set A to B
A를 B로 설정합니다
[PASS]
파라메터를 넘기는 처리에 주로 사용한다.
- Pass A to B
A를 B로 넘깁니다
References
https://chris.beams.io/posts/git-commit/
https://blog.ull.im/engineering/2019/03/10/logs-on-git.html
https://richone.tistory.com/26
