커밋
구현 방법을 같이 서술하는 식으로 최대한 구체적으로 서술해주면 좋음
기본 포맷
type| header
-------------------
body
footer
타입
- Fix: 수정 🐛
:bug:
- 잘못된 동작을 고칠 때 주로 사용한다.
- in 을 명시하여 어디를 수정했는지 작성할 수 있다.
- to 또는 for 로 왜 그렇게 수정했는지 작성할 수 있다.
- when을 통해 어느 상황에서 발생했는지를 작성할 수 있다.
- Add: 추가 ✨
:sparkles:
- 무언가 추가할 때 사용한다.
- 단순히 코드나 문서가 추가되었음을 작성할 수 있다.
- 왜 추가했는지 무엇을 어디에 추가했는지 등을 나타낼 수 있다.
- Remove: 삭제 🔥
:fire:
- 삭제가 있을 때 사용한다.
- from을 적어서 어디에서 삭제했는지 명시할 수 있다.
- Update: 보완 🎨
:art:
- Fix와 달리 원래 정상적으로 동작했지만 보완하는 개념이다.
- 코드를 단순화 했을 때도 사용한다.
- Implement: 구현 🤩
:star_struck:
- 무언가 구현을 달성했을 때 사용한다.
- 큰 단위에 작성하면 좋다.
- Prevent: 방지 🔓
:lock:
- 특정한 동작을 못하게 막을 때 사용한다(예외처리..??)
- Move: 이동 🚚
:truck:
- 코드나 파일의 이동에 사용한다.
- Move A to B, Move A into B의 형태로 많이 쓰인다.
- Rename: 이름변경 ✏️ ****
:pencil2:
- 이름의 변경이 있을 때, Rename A to B의 형태로 많이 쓰인다.
- Improve: 개선 ⚡
:zap:
예시
✨| PlayerController Script 이동 로직 추가
--------------------------------------
- 키 입력을 받아 포지션값 이동
- 부드럽게 캐릭터가 돌아가도록 구현
변수
모든 변수 이름은 카멜표기법을 사용한다.(단어의 앞글자는 대문자)
변수명은 value로 대체