git은 버전관리를 위해 사용되기 때문에 현재까지의 변경사항들이 기록으로 담겨있다.
의미있는 변경이 있을 때마다 이를 commit메세지로 요약해 남겨둔다.
그렇기 때문에 제3자가 코드의 변경과정을 볼 때 commit이 어떠냐에 따라 코드가독성이
쉬워지거나 어려워 질 수 있다.
지금까지는 별로 생각없이 commit을 작성해 왔는데 다음주부터 프로젝트를 시작하게 된다.
보통 4인이 팀이되니 나머지 3인이 나의 불친절한 commit때문에 고생하시지 않도록 미리 좋은 습관들
들여야 겠다.
좋은 글들이 있어서 나에게 필요한 부분만 가져와봤다.
알아두면 좋은 규칙들
-
동명사보다는 명사를 사용하라.
문장이 간결해진다. -
관사는 사용하지 않는다.
꼭 필요한 경우가 아니면 a, an, the는 사용하지 않는다. -
Not useDon't use(o)
Don't use spdy on node >= v10.0.0
Don't write to the persisted query cache until execution will begin.- 오타수정은 Fix typo
자주 사용하는 커밋
fix
fix : 올바르지 않은것을 고친경우에 사용한다.
fix A in B : B의 A를 수정한다.
fix A which B : fix A로 끝낼 수 있지만 A의 정보를 더 담기위해 사용된다.
fix A to B : B를 위해 A를 수정한다.(이유에 대한 설명)
fix A so that B : A를 수정해서 B가 되었다 (고쳐진 결과 B에 대한 설명)
correct
correct A : A를 고친다. 주로 문법의 오류나 타입의변경, 이름변경에 사용된다.
add
add A : A를 추가한다.(목적이 없기때문에 자주 사용되지 않는다.)
add A for B : B를 위해 A를 추가했다.
add A to B : B에 A를 추가했다.
remove
remove A : A를 삭제한다. A앞에는‘unnecessary’(불필요한), ‘useless(쓸모없는)’, ‘unneeded(불필요한)’, ‘unused(쓰이지 않는)’, ‘duplicated(중복되는)’을 붙인다.
remoce A from B : B에서 A를 삭제한다.
use
use A : A를 사용했다. (목적이 없기때문에 자주 사용되지는 않는다.)
use A to B : B가 되도록 A를 사용했다.
use A in B : B에서 A를 사용한다.
use A instead of B : B대신 A를 사용한다.
set
set A to B : A를 B로 설정한다. 변수값을 변경하는등 작은 수정에 사용된다.
refactor
refactor A : A에 대한 전면적 수정이 있을때 사용한다.
simplify
simplify A : A를 단순화한다.
update
update A to B : 개정이나 버전업데이트 (잘못된걸 바로잡는게 아니기에 fix와는 다르다.)
revise
revise A : revise는 문서의 개정이 있을 때 사용된다. A문서를 개정한다.
make
make A B : A를 B하게 만듭니다. // ex) make config object read-only
prevent
prevent A : A하지 못하게 막는다.
prevent A from B : A가 B하지 않게 막는다.
move
move A to B : A를 B로 옮긴다. 주로 코드의 이동이 있을 때 사용된다.
rename
rename A to B : 이름을 A에서 B로 바꾼다.
참고:
https://blog.ull.im/engineering/2019/03/10/logs-on-git.html
https://junwoo45.github.io/2020-02-06-commit_template/?fbclid=IwAR3YYaSk0w6iaVIL0JPzNnN8hLAKGfSZV_mWdi96MkhPtXaZGe74hAOQ5yw
