오늘의 키워드
오늘 팀 프로젝트 시작과 관련한 발제가 있었다.
여태까지의 프로젝트는 프로그래머가 나 한명이어서 괜찮았지만, 이제는 같은 팀이 모두 프로그래머다.
따라서, git을 이용한 협업을 진행해야하는데, 그 전에 알아두면 좋은 것들을 정리해볼까한다.
Commit 메시지 컨벤션
commit 메시지도 컨벤션이 있다고 한다. 협업을 하며 다른 사람이 알아보기 쉽게 해주고, 자신이 작업했던 사항들을 돌아보기 쉽게 해준다.
1. Commit 메시지 구조
type: subject // 제목
body // 본문 (생략 가능)
footer // 꼬리말 (생략 가능)2. Commit Type
| Type | 설명 |
|---|---|
| feat | 새로운 기능이 추가된 경우 |
| fix | 버그를 고친 경우 |
| style | 코드 포맷 변경 |
| refactor | 코드를 리팩토링한 경우 |
| comment | 주석 추가/변경 |
| docs | 문서를 수정한 경우 |
| test | 테스트 코드를 추가한 경우 (프로덕션 코드는 바뀌지 않음) |
| chore | 빌드 테스트 업데이트, 패키지 매니저 설정 (프로덕션 코드는 바뀌지 않음) |
| rename | 파일이나 폴더명을 수정하거나 옮기는 작업인 경우 |
| remove | 파일을 삭제한 경우 |
3. Subject
- 50자를 넘기지 않고, 특수문자를 사용하지 않는다.
- 첫 글자는 대문자로 작성한다.
- 과거시제를 사용하지 않고, 명령조를 사용한다.
- Fixed (X) -> Fix (O)
- Added (X) -> Add (O)
4. Body
- 선택사항이므로 부연설명이 필요 없는 경우 생략 가능
- 한 줄에 72자를 넘기지 않는다. 넘긴다면 줄바꿈을 할 것.
5. Footer
- 선택사항이므로 생략 가능하다.
- git repository를 보면 issue 페이지가 있는데, issue tracker id를 작성한다.
- Resolves: #1
- 1번 이슈를 해결했다는 뜻
- See also: #23, #30
- 23번, 30번 이슈를 참고하면 좋겠다는 뜻
- Resolves: #1
6. 사용 예시
ex1)
fix: Fix item unequipment exception error
아이템 장착 해제 시 발생하던 exception 오류 수정
Resolve: #1
ex2)
Implement battle system
던전 입장 후 몬스터와 배틀 시스템 구현
See also: #20
Commit 메시지 영어사전
Commit 메시지 작성 시 자주 사용되는 영어들을 모은 좋은 글
제목 짓기가 어려울 때 참고하면 좋을 것 같다.
참고 자료
https://blog.ull.im/engineering/2019/03/10/logs-on-git.html
https://doublesprogramming.tistory.com/256
https://overcome-the-limits.tistory.com/entry/%ED%98%91%EC%97%85-%ED%98%91%EC%97%85%EC%9D%84-%EC%9C%84%ED%95%9C-%EA%B8%B0%EB%B3%B8%EC%A0%81%EC%9D%B8-git-%EC%BB%A4%EB%B0%8B%EC%BB%A8%EB%B2%A4%EC%85%98-%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0
game developer