[Git] 개인 학습 Repository를 위한 Git 커밋 메시지 컨벤션

커밋 메시지의 구조와 명확성

• -m 옵션을 여러번 사용해서 제목과 본문 분리하기
• git commit -m "동작 대상 결과물" -m "관련 작업 내용"

git commit -m "Add Docker 학습 노트" -m "기본 도커 명령어, 도커의 유연성, 도커 이미지 작동 방식"

 

커밋 메세지 제목에 사용하는 동사들

• 제목에 사용할 첫 단어

Add: 새로운 파일, 기능, 코드, 문서 등을 추가할 때 사용합니다.

Update: 기존 코드나 파일을 수정(업데이트)할 때 사용합니다.

Fix: 버그 수정이나 오류 해결에 사용합니다.

Refactor: 코드를 개선하거나 리팩토링할 때 사용합니다. 기능적 변경이 아닌 구조적/성능적 개선을 의미합니다.

Remove/Delete: 코드, 파일, 기능 등을 제거할 때 사용합니다.

Document: 문서 작성 및 업데이트에 사용합니다.

Test: 테스트 코드 추가나 수정에 사용합니다.

Implement: 새로운 기능을 구현할 때 사용합니다.

Optimize: 성능 최적화 관련 변경에 사용합니다.

Style: 코드 스타일 변경이나 포맷팅에 사용합니다. 기능적 변경은 포함하지 않습니다.

Rename: 파일, 변수, 함수 등의 이름을 변경할 때 사용합니다.

Move: 파일이나 코드를 다른 위치로 이동할 때 사용합니다.

Configure: 구성 파일 변경에 사용합니다.

Merge: 다른 브랜치를 병합할 때 사용합니다.

 

 

용어의 일관

• 언어, 프레임워크, 프로그램은 영어단어 사용으로 통일하기
• 내가 공부할 학습노트니까 그 외의 설명은 한글로 작성하기

git commit -m "Add Docker 학습 노트" 
-m "Docker 인기 요인, 백그라운드 매커니즘, Docker 이미지 개념, Docker 레지스트리, -p 명령어, 다중 컨테이너 인스턴스, 여러 포트에서의 병행 실행, -d 명령어"

 

 

폴더 이동이나 구조 변경과 같은 파일 시스템 관련 변경 - GPT의견

 

폴더 이동만 따로 커밋하는 경우

• 변경의 명확성: 폴더 이동이나 구조 변경과 같은 큰 변경사항은 다른 변경사항과 분리하여 커밋하는 것이 좋습니다. 이렇게 함으로써 커밋 로그가 명확해지고, 추후에 문제가 발생했을 때 해당 커밋을 찾아내기 쉬워집니다.
• 커밋 메시지: 이런 경우, 커밋 메시지는 변경사항을 명확하게 설명해야 합니다. 예를 들어, "Move study notes to new directory structure"와 같이 작성할 수 있습니다.

 

다른 파일 변경과 함께 커밋하는 경우

• 편의성: 폴더 이동이나 구조 변경이 다른 파일 변경사항과 밀접하게 연관되어 있다면, 모든 변경사항을 한 번에 커밋하는 것이 더 편리할 수 있습니다.
• 커밋 메시지: 이 경우 커밋 메시지는 모든 변경사항을 포괄해야 합니다. 예를 들어, "Update study notes and reorganize directory structure"와 같이 작성할 수 있습니다.

 

선택 기준

• 프로젝트의 규모와 복잡성: 작은 프로젝트나 간단한 변경사항의 경우, 여러 변경사항을 한 번에 커밋하는 것이 더 실용적일 수 있습니다.
• 팀의 작업 방식: 팀이나 프로젝트의 커밋 정책에 따라 결정할 수도 있습니다. 명확한 이력 관리를 중시하는 경우에는 별도로 커밋하는 것이 좋습니다.

일반적으로는 구조 변경과 같은 큰 변경사항은 별도의 커밋으로 처리하는 것이 좋으며, 이렇게 하면 커밋 로그의 가독성과 관리가 용이해집니다.

일반적으로는 구조 변경과 같은 큰 변경사항은 별도의 커밋으로 처리하겠음(23.12.12)

 

 

파일 시스템 관련 변경 처리

• 변경 사항에 대한 명확한 컨텍스트를 제공하기

git commit -m "Move Docker 학습노트.md from [원래 경로] to [새 경로]"

git commit -m "Move Docker 학습노트.md from notes/ to docker/"

 

 

파일 이름 지정 기준

• 현재 내 고민. 강의 학습 필기파일의 이름을 어떻게 할 것인가
• 현재 파일명 (AjaxStudy_01.md, SpringSecyrityStudy_02.md, DockerStudy_01.md)
• 변경하려는 파일명 ( Ajax_학습노트_01.md )

명확성: 파일 이름만 보고도 그 내용을 쉽게 이해할 수 있어야 합니다.
일관성: 동일한 종류의 파일들은 일관된 네이밍 규칙을 따라야 합니다.
간결성: 파일 이름은 가능한 한 간결하면서도 필요한 정보를 포함해야 합니다.

많은 종류의 문서가 혼재하는 폴더에서 해당 파일이 학습 자료임을 더 분명히 드러내는 데 도움이 될 수 있습니다.

Ajax_학습노트_01.md 와 같은 양식으로 md파일 전면 수정하겠음(23.12.12)

 

 

 

 

(필요할 때 마다 내용 추가)