Git : Commit Message

Git Commit Message

저는 보통 Git Commit Message를 ADD : [카테고리] 카테 고리 세부 내용 - 메세지 형식으로 사용하는데, 이 때 사용하는 메세지들을 소개하려고 합니다.

FIX

보통 올바르지 않은 동작을 고친 경우에 사용합니다.

ADD

코드나 테스트, 예제, 문서 등의 추가가 있을 때 사용합니다

REMOVE

코드의 삭제가 있을 때 사용합니다. ‘Clean’이나 ‘Eliminate’를 사용하기도 합니다. 보통 A 앞에 ‘unnecessary’, ‘useless’, ‘unneeded’, ‘unused’, ‘duplicated’가 붙는 경우가 많습니다.

UPDATE

개정이나 버전 업데이트가 있을 때 사용합니다. Fix와는 달리 Update는 잘못된 것을 바로잡는 것이 아니라는 점에 주의해야 합니다. 원래도 정상적으로 동작하고 있었지만, 수정, 추가, 보완을 한다는 개념입니다. 코드보다는 주로 문서나 리소스, 라이브러리등에 사용합니다.

CORRECT

주로 문법의 오류나 타입의 변경, 이름 변경 등에 사용합니다.

MOVE

코드의 이동이 있을 때 사용합니다.

RENAME

이름 변경이 있을 때 사용합니다.

SET

변수 값을 변경하는 등의 작은 수정에 주로 사용합니다.

PASS

파라메터를 넘기는 처리에 주로 사용합니다.

REFACTOR

전면 수정이 있을 때 사용합니다.

SIMPLIFY

복잡한 코드를 단순화 할 때 사용합니다. Refactor의 성격이 강하나 이보다는 약한 수정의 경우 이용하면 좋습니다.

IMPROVE

향상이 있을 때 사용합니다. 호환성, 테스트 커버리지, 성능, 검증 기능, 접근성 등 다양한 것들이 목적이 될 수 있습니다.

VERIFY

검증 코드를 넣을 때 주로 사용합니다.

USE

특별히 무언가를 사용해 구현을 하는 경우입니다. ‘사용하였음’을 이야기 할 때는 대체적으로 목적이 필요하기 때문에 이 용법은 자주 사용되지 않습니다.

MAKE

주로 기존 동작의 변경을 명시합니다.

ALLOW

Make와 비슷하지만, 허용을 표현할 때 사용합니다.

IMPLEMENT

코드가 추가된 정도보다 더 주목할 만한 구현체를 완성시켰을 때 사용합니다. ‘Add’에 비해 더 큰 단위의 코드 추가에 사용되며, 특히 모듈이나 클래스 등의 단위에 사용되기 때문에 특별히 목적을 부여 해주지 않아도 되는 경우가 많습니다. 따라서 ‘Add’에 비해 to나 for가 함께 사용되는 경우가 적습니다.

REVISE

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

ENSURE

무엇이 확실하게 보장받는다는 것을 명시합니다. if 구문처럼 조건을 확실하게 주었을 때에도 사용 될 수 있습니다. ‘Make sure’도 같은 용도로 사용될 수 있습니다.

PREVENT

특정한 처리를 못하게 막습니다

AVOID

‘Prevent’는 못하게 막지만, ‘Avoid’는 회피합니다. if 구문으로 특정한 동작을 제외시키는 경우에도 사용 할 수 있습니다.

---