01 개요
본 문서에서는 git / github 사용시에 필요한 코딩규약(code convention)을 정한다.
이러한 사항은 각 개인, 집단마다 다를 수 있으며 이 코딩규약은 일반적으로 많이 사용되고 있는것으로 보이는 규약들을 참조하여 정리한 것이다.
최종 수정일 : 2023.01.24
02 커밋 메시지
커밋 메시지는 git / github에서 각 작업단위에 대해 파악할 수 있는 몇 안되는 수단 중 하나이다. 일반적으로 커밋 메시지에는 다음과 같은 사항이 들어간다.
머릿말 : 커밋 유형, 관련 이슈
본문 : 구체적인 수정 사항
꼬리말 : 관련 이슈, 기타 메타데이터
커밋메시지는 발생하는 수많은 커밋을 효과적으로 관리하기 위해 간단하고 명료하여야 한다. 짧은 메시지로 필요한 내용 대부분을 표현할 수 있다면 상세한 내용은 가급적 생략하는것이 좋다.
02.01 머릿말
02.01.01 커밋유형
커밋 유형엔 다음과 같은 것들이 있다.
INIT
ADD (FEAT)
MOVE
REMOVE
UPDATE
FIX
SET
DOCS
STYLE
REFACTOR
INIT
요구사항에 따라 처음 코드를 작성한 시점에 사용하는 유형이다. 초기화(Init)와 비슷한 의미로 이해하여도 좋다.
ADD
작성되어 있는 파일에 코드나 기능을 추가하였을 때 사용하는 유형이다.
MOVE
작성되어 있는 파일에 대해 단순히 파일명을 바꾸거나 경로를 재배치하였을 때 사용하는 유형이다.
REMOVE
작성되어 있는 코드나 기능을 삭제하였을 때 사용하는 유형이다.
UPDATE
이미 존재하는 기능을 더 발전된 기능으로 변경하였을 때 사용하는 유형이다.
FIX
결함이 있는 기능을 정상적으로 작동하도록 수정하였을 때 사용하는 유형이다.
SET
정상적으로 작동하고 있는 기능의 파라미터 값 등을 수정할 때 사용하는 유형이다.
DOCS
문서를 수정하였을 때 사용하는 유형이다.
STYLE
내용이나 기능의 변경이 거의 없이 코드 작성 스타일을 변경하였을 때 사용하는 유형이다.
REFACTOR
문서나 코드의 전면적인 수정이 있을 때 사용하는 유형이다.
02.01.02 관련 이슈
관련 이슈를 머릿말에 표기하는 경우 (#00000)과 같은 방식으로 표기한다.
02.02 본문
For more detailed explanation, changed contents are like below.
1. Inform 1
2. Inform 2
3. Inform 3
본문을 적을 필요가 있는 경우 서술식으로 적는 대신 위와 같이 나열식으로 간략하게 적는다. 내용이 많을 경우 본문으로 서술하기보다는 각 단위별로 커밋하여 커밋이 변경 내용의 최소 단위가 되도록 유지하는 편이 바람직하다.
02.03 꼬리말
꼬리말을 적을 필요가 있는 경우에는 머릿말이나 본문에서 언급하지 않은, 관련 프로젝트에 대한 메타데이터등을 표기해주도록 한다.
