커밋 메시지
단계
git diff --staged를 실행하여 커밋될 내용을 확인합니다. 스테이징된 내용이 없으면 그 사실을 알리고, 모든 변경사항을 스테이징(git add -A)할지 특정 파일만 할지 물어보세요. 허락 없이 스테이징되지 않은 작업을 커밋하지 마세요.git log --oneline -15를 실행하고 보이는 스타일(Conventional Commits의 feat(api): …, 티켓 접두사 ABC-123 …, 평문 문장)과 일치시키세요. 명확한 컨벤션이 없으면 평문 명령형 문장을 사용하세요.- 스테이징된 변경사항이 여러 개의 관련 없는 작업을 포함한다면, 하나의 메시지를 작성하기 전에 별도의 커밋으로 분할할 것을 제안하세요.
형식
<요약 줄, 명령형, 최대 ~72자, 마침표 없음>
<본문: 변경 이유와 리뷰어가 diff에서 볼 수 없는 내용. 72자에서 줄바꿈. 사소한 변경은 본문 생략>
<트레일러: Fixes #123, Co-authored-by: …, BREAKING CHANGE: …>
- 명령형: "Add retry to upload", "Added" 또는 "Adds"가 아닙니다.
- 요약 줄은 어떤 파일이 변경되었는지가 아니라 사용자 또는 코드베이스에 무엇이 변경되었는지 설명합니다.
- 본문은 왜 변경되었는지 설명합니다: 버그, 제약 조건, 선택하지 않은 대안. diff는 이미 무엇이 변경되었는지 보여줍니다.
- Conventional Commits를 사용하는 경우, 타입을 정직하게 선택하세요:
feat(새로운 기능), fix(버그 수정), refactor(동작 변경 없음), perf, docs, test, build, ci, chore. 호환 깨는 변경은 !로 표시하고 BREAKING CHANGE: 트레일러를 추가하세요.
예시
fix(auth): 만료 전에 토큰을 갱신하도록 수정, 만료 후가 아닌
토큰 수명의 마지막 30초 동안 이루어진 요청은 401 오류가 발생했습니다.
이유는 갱신이 첫 번째 실패 시에만 실행되었기 때문입니다.
대신 60초 미만이 남았을 때 갱신하도록 변경했습니다.
Fixes #482
사용하지 않는 CSV 내보내기 엔드포인트 제거