Commit(커밋)메세지

1. 형식

커밋 메시지는 보통 두 부분으로 나눌 수 있습니다: 제목과 본문입니다.

• 제목: 변경 사항의 요약을 간결하게 표현합니다. 50자 이내로 작성하는 것이 좋습니다.
• 본문: 변경 사항에 대한 자세한 설명을 추가합니다. 필요에 따라 여러 줄로 작성할 수 있으며, 각 줄은 72자 이내로 제한하는 것이 좋습니다.

2. 첫 글자를 대문자로

제목의 첫 글자는 대문자로 시작합니다. 예: Fix: 버그 수정

3. 동사 사용

제목은 현재 시제의 동사로 시작하는 것이 좋습니다. 예:

• Add: 새 기능 추가
• Update: 기존 기능 업데이트
• Remove: 사용되지 않는 코드 삭제

4. 태그 사용

위에서 언급한 Conventional Commits 규칙에 따라 태그를 사용하여 변경 사항의 유형을 나타낼 수 있습니다. 주요 태그는 다음과 같습니다:

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• style: 코드 스타일 변경
• refactor: 기능 변화 없는 리팩토링
• test: 테스트 추가/수정
• chore: 기타 잡일

5. 본문에 추가 정보 포함

변경 사항이 복잡하거나 중요한 경우, 본문에 다음과 같은 정보를 포함할 수 있습니다:

• 이유: 왜 이 변경을 했는지 설명합니다.
• 관련 이슈: 해당 변경과 관련된 이슈 번호를 언급합니다. 예: Fixes #123
• 사용된 기술: 특정 기술이나 라이브러리를 사용했다면, 간략하게 언급합니다.

6. 명확하고 간결하게

커밋 메시지는 다른 개발자나 미래의 자신이 쉽게 이해할 수 있도록 명확하고 간결하게 작성해야 합니다.

예시

여러 가지 예시를 살펴보면:

좋은 예

 

feat: 사용자 프로필 페이지 추가

사용자가 자신의 프로필을 볼 수 있는 페이지를 추가했습니다.
이 페이지에서는 사용자 이름, 이메일 및 프로필 사진을 표시합니다.

 

나쁜 예

 

수정함