[Git] 좋은 커밋 메시지 작성하기, 정책 만들기(git, commit, convention)

 

 

---

커밋 메시지 규칙

1. 제목은 영문 기준 50자 , 한글 기준 25자 이내
2. 제목은  명령문, 부정명령문 형식 사용
3. 제목 첫글자를 대문자로
4. 동명사보다 명사를 사용 (ing X)
5. 제목 끝에 . 금지
6. 제목과 본문을 한 줄 띄워 분리하기
7. 본문은 영문 기준 72자 , 한글 기준 36자 마다 개행

 

커밋 메시지 예)

Fix member of values optional in ViewPropTypes
[수정] 회원 가입의 버그를 수정

 

• Refactor subsystem X for readability
• Update getting started documentation
• Remove deprecated methods
• Release version 1.0.0
• Merge pull request #123 from user/branch

 

Github 이슈를 종료하는 키워드

• close
• closes
• closed
• fix
• fixes
• fixed
• resolve
• resolves
• resolved

 

 

영어 단어 목록

FIX

보통 올바르지 않은 동작을 고친 경우 사용

Fix A // A를 수정

Fix A in B // B의 A를 수정

Fix A which B, Fix A that B // B절인 A를 수정

Fix A to B, Fix A to be B // B를 위해 A를 수정

Fix A so that B // A를 수정해서 B가 됨

Fix A where B // B처럼 발생하는 A를 수정

Fix A when B // B일 때 발생하는 A를 수정

 

ADD

코드나 테스트, 예제, 문서 등의 추가한 경우 사용

Add A // A를 추가

Add A for B // B를 위해 A를 추가

 

 

REMOVE

코드의 삭제 한 경우 사용

Remove A // A를 삭제

Remove A from B // B에서 A를 삭제

 

 

USE

무언가를 사용해 구현을 하는 경우

Use A // A를 사용

Use A for B // B에 A를 사용

Use A in B // B 대신 A를 사용

 

 

REFACTOR

기능, 페이지 등 전면 수정

 

SIMPLIFY

복잡한 코드를 단순화, REFACTOR 보다 약한 수정

 

 

UPDATE

주로 문서나 리소스, 라이브러리 등 개정이나 버전 업데이트가 있을 때 사용

잘못된 것을 바로잡는 것이 아니라 정상적으로 동작하고 있었지만, 수정, 추가, 보완을 한다는 개념

Update node to 6.1.0

 

 

REVISE

Update와 비슷하나 문서의 개정이 있을 때 주로 사용

 

 

CORRECT

문법의 오류나 타입의 변경, 이름 변경 등에 사용

 

MAKE

기존 동작의 변경을 명시

ALLOW

기존 동작을 허용

 

IMPLEMENT

코드가 추가된 정도보다 더 주목할 만한 구현체를 완성시켰을 때 사용

 

MOVE

코드의 이동

Move A to B, Move A into B

RENAME

이름 변경

Rename A to B