DrunkenNeoguri
commented
1 year ago 커밋 메시지는 다음과 같이 작성합니다.
[제목]
- 제목은 50글자 이내로 작성합니다.
- 개조식에 맞춰 쓰되 마침표는 사용하지 않습니다.
- 제목 끝에 이슈번호를 달아주십시오.
- 형식은 (키워드): [작업한 내용 요약] [이슈 번호]로 씁니다.
- 예시
- Add: 공용 UI 컴포넌트인 CommonInput 생성 및 구현 # 1
- Fix: 메인 페이지에서 받아오는 값이 다른 문제 수정 # 4 (실제 쓸 때는 붙여써주세요.)
[본문]
- 제목 내용에서 좀 더 보강할 내용이 필요하다면 본문에 상세하게 작성해줍니다.
- 공용 컴포넌트의 활용법이나 문제 수정 후의 참고 사항 등, 커밋 사항과 관련하여 참고해야 할 내용들을 작성해주세요.
[키워드]
- 제목에 작성할 때에 앞에 붙일 키워드는 아래에서 정한 것으로 사용합니다.
- 경우에 따라, 키워드를 추가할 필요가 있을 시 댓글에 추가로 작성하도록 합니다.
- Init: 개발 환경과 관련하여 초기 세팅 등을 커밋할 시에 사용합니다.
- Add: 일부 기능 등을 새로 추가하여 커밋할 시에 사용합니다.
- Fix: 이미 존재하는 기능에서 수정 사항이 있거나 버그나 문제 등의 이슈를 수정하여 커밋할 시에 사용합니다.
- 파일의 수정과 삭제 모두 Fix 키워드로 관리합니다.
- 파일 이동이나 이름 변경도 Fix 키워드로 관리합니다.
- Use: 새로운 패키지(라이브러리나 프레임워크) 등을 설치 후 커밋할 시에 사용합니다.
- 본문에 설치한 패키지와 관련한 설명들을 작성해주도록 합니다.
- Merge: 두 개의 브랜치를 통합할 시에 사용합니다.
- Release: 배포를 진행할 시에 사용합니다.
[이슈 설명]
본 일감은 현재 정리되지 않은 커밋 메시지의 작성 규칙 및 작성 템플릿을 결정 및 관리하기 위한 일감입니다. 커밋 메시지의 작성 규칙이 정립될 경우, 댓글 Preview에 남겨 관련 사항을 기록합니다. 작성 템플릿을 생성할 경우에도 동일하게 기록합니다.