이전에 작성한 커밋 메세지 규칙에 이어 커밋 메세지에 많이 쓰이는 영어 단어를 정리해 보았다. 제목의 description에서는 변경 내용을 현재형 동사로 요약해서 적어야 하는데 어떤 영단어들이 쓰이는지 알아보자 ヾ(≧▽≦*)o
🧐 description에서 많이 쓰이는 영단어
[FIX]
가장 자주 사용되는 커밋 로그중 하나로 올바르지 않은 동작을 고치는 경우
Fix A: A를 수정합니다.Fix A in B: B의 A를 수정합니다.Fix A so that B: A를 수정해서 B가 되었습니다.
[ADD]
코드나 테스트, 예제, 문서 등의 추가가 있을 때 사용
Add A: A를 추가합니다.Add A for B: B를 위해 A를 추가했습니다.Add A to B: B에 A를 추가합니다.
[REMOVE]
코드의 삭제가 있을 때 사용,
Clean이나Eliminate를 사용하기도 한다. 보통A앞에unnecessary,useless,unused,unneeded,duplicated가 붙음
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를 사용합니다.Use A instead of B: B 대신 A를 사용합니다.
[REFACTOR]
전면 수정이 있을 때 사용
Refactor A
[SIMPLIFY]
복잡한 코드를 단순화 할 때 사용,
Refactor보다는 약한 수정일 경우 사용
Simplify A: A를 단순화 합니다.
[UPDATE]
개정이나 버전 업데이트가 있을때 사용, fix와 달리 원래도 정상적으로 동작하는 경우에 사용
Updata A to B: A를 B로 업데이트 합니다.
[IMPROVE]
호환성, 테스트 커버리지, 성능, 검증 기능, 접근성 등 다양한 것들을 목적으로 향상이 있을 때 사용
Improve A: A를 향상시킵니다.
[MAKE]
주로 기존 동작의 변경을 명시, 새롭게 만들었을 경우
Add사용
Make A B: A를 B하게 만듭니다
[IMPLEMENT]
add보다 큰 단위의 코드를 추가하고 완성시켰을때 사용
Implement A: A를 구현합니다Implement A to B: B를 위해 A를 구현합니다
[REVISE]
Update와 비슷하나 문서의 개정이 있을때 주로 사용
Revise A: A 문서를 개정합니다
[CORRECT]
문법의 오류나 타입의 변경, 이름 변경등에 사용
Correct A: A를 고칩니다
[ENSURE]
Make sure과 같은 용도로 확실하게 보장받는다는것을 명시
Ensure A: A가 확실히 보장 되도록 수정했습니다
[PREVENT]
특정한 처리를 못하게 막을때 사용
Prevent A: A하지 못하게 막습니다Prevent A from B: A를 B하지 못하게 막습니다
[AVOID]
prevent는 못하게 막지만,avoid는 회피할때 사용
Avoid A: A를 회피합니다Avoid A if B: B인 상황에서 A를 회피합니다Avoid A when B: B인 상황에서 A를 회피합니다
[MOVE]
코드의 이동이 있을 때 사용
Move A to B: A를 B로 옮깁니다Move A into B: A를 B로 옮깁니다
[RENAME]
이름 변경이 있을때 사용
Rename A to B: A를 B로 이름 변경합니다
[ALLOW]
make와 비슷하지만 허용을 할때 사용
Allow A to B: A가 B를 할 수 있도록 허용합니다
[VERIFY]
검증 코드를 넣을 때 주로 사용
Verify A: A를 검증합니다
[SET]
변수의 값을 변경하는등의 작은 수정에 사용
Set A to B: A를 B로 설정합니다
[PASS]
파라미터를 넘기는 처리에 사용
Pass A to B: A를 B로 넘깁니다
📚 Ref
https://velog.io/@dlvnfma0501/Commit-message-작성법
https://blog.ull.im/engineering/2019/03/10/logs-on-git.html
