본문 바로가기
개발 기본 규칙 및 환경설정

[개발 규칙] Git Commit Message

by cogito21_cpp 2024. 7. 19.
반응형

Git Commit Message 규칙

Git Commit Message 형식

타입: 제목

본문

꼬리말

타입

feat: 새로운 기능 추가

fix: 버그 수정

docs: 문서 수정

style: 코드 포맷팅, 세미콜론 누락 등 코드 변경이 없는 경우

- refactor: 코드 리팩토링

- test: 테스트 추가 또는 수정

- chore: 빌드 업무 수정, 패키지 매니저 설정 등

- perf: 성능 향상 관련 변경

- ci: CI 설정 파일 및 스크립트 변경

- build: 빌드 시스템 또는 외부 종속성에 영향을 미치는 변경 사항

제목

- 길이: 50자 이내

- 스타일: 동사(현재 시제)로 시작하고 첫 글자는 대문자 사용

- 마침표: 제목 끝에 마침표 사용하지 않음

예시

feat: Add user authentication

본문

길이: 각 행은 72자 이내로 작성

내용: 무엇을, 왜 변경했는지 설명

빈 행: 제목과 본문 사이에 빈 행 추가

예시

feat: Add user authentication Added JWT-based user authentication to the login system. 

This will enhance security and provide a better user experience.

 

꼬리말

참조: 관련된 이슈 번호 또는 다른 참조 추가

예시

feat: Add user authentication Added JWT-based user authentication to the login system.

This will enhance security and provide a better user experience. 

Closes #123

 

예시

새로운 기능 추가

feat: Add user profile page Implemented the user profile page with editable user details. 

This allows users to update their personal information easily. 

Closes #45

버그 수정

fix: Correct login validation issue Fixed a bug where the login form did not validate user credentials correctly.

Now, incorrect login attempts will show an appropriate error message. 

Closes #67

문서 수정

docs: Update README with setup instructions Added detailed setup instructions to the README file to help new developers get started quickly.

코드 스타일 변경

style: Format CSS files Reformatted all CSS files according to the new style guidelines.

리팩토링

refactor: Simplify authentication logic Refactored the authentication logic to reduce complexity and improve readability.
반응형