서론
우테코 2주차가 시작되었다. 이번주 과제는 숫자야구 만들기이다. 오늘은 기능 요구 사항과 프로그램 요구 사항 그리고 1주차에는 없던 추가된 요구 사항을 정독하였다.
특히 과제 진행 요구 사항에서
기능을 구현하기 전
docs/README.md에 구현할 기능 목록을 정리해 추가한다.Git의 커밋 단위는 앞 단계에서
docs/README.md에 정리한 기능 목록 단위로 추가한다.
커밋 메시지 컨벤션 가이드를 참고해 커밋 메시지를 작성한다.
이것들이 생소하게 느껴졌다. 무언가를 만들기전에 머리속으로 생각하거나 노트에 끄적이는 정도로 구현할 기능들을 정리했었는데 각잡고 할려고 하니 살짝 걱정되었다.
커밋 컨벤션
지금까지 내가 작성했던 커밋들을 보면 누적될수록 가독성이 떨어지고 만약 여러 사람들과 개발을 같이 할 때는 내가 커밋한 내용을 상대가 이해하는데 시간이 걸리고 유지보수하기에도 어려워진다.
커밋 메세지 컨벤션 가이드를 활용하면 서로간의 소통이 더욱 원활해질 것이다.
메세지 구조
크게 제목 / 본문 / 꼬리말 세 파트로 나눈다. 각 파트는 빈줄을 두어서 구분한다.
태그: 제목
'태그: 제목'의 형태이며 : 뒤에만 space를 한다.
태그
Feat 새로운 기능을 추가할 경우 Fix 버그를 고친 경우 Design CSS 등 사용자 UI 디자인 변경 !BREAKING CHANGE 커다란 API 변경의 경우 !HOTFIX 급하게 치명적인 버그를 고쳐야하는 경우 Style 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우 Refactor 프로덕션 코드 리팩토링 Comment 필요한 주석 추가 및 변경 Docs 문서를 수정한 경우 Test 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X) Chore 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X) Rename 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우 Remove 파일을 삭제하는 작업만 수행한 경우 제목
제목은 코드 변경 사항에 대한 짧은 요약을 나타냅니다. 제목은 다음의 규칙을 지킵니다.
- 제목의 처음은 동사 원형으로 시작합니다.
- 총 글자 수는 50자 이내로 작성합니다.
- 마지막에 특수문자는 삽입하지 않습니다. 예) 마침표(.), 느낌표(!), 물음표(?)
- 제목은 개조식 구문으로 작성합니다.
만약 영어로 작성하는 경우 다음의 규칙을 따릅니다.
- 첫 글자는 대문자로 작성합니다.
- "Fix", "Add", "Change"의 명령어로 시작합니다.
한글로 제목을 작성하는 경우 다음의 규칙을 따릅니다.
- "고침", "추가", "변경"의 명령어로 시작합니다.
본문
- 본문은 한 줄 당 72자 내로 작성합니다.
- 본문 내용은 양에 구애받지 않고 최대한 상세히 작성합니다.
- 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명합니다.
꼬리말
optional -> 아직 공부 안함 추후에 다시 할 예정
느낀점
매주 새롭고 매주 배워간다. 그리고 커밋 컨벤션을 알아가다 보니 내가 지금까지 작성했던 커밋은 정말 형편없이 보였다. 뭐 물론 몰랐기 때문이고 배워가는 과정이기에 앞으로의 커밋은 규칙을 신경쓰고 가독성 좋게 작성하도록 노력해야겠다.
