git 커밋 메세지는 어떻게 해야하는가

https://meetup.nhncloud.com/posts/106

https://blog.ull.im/engineering/2019/03/10/logs-on-git.html

https://meetup.nhncloud.com/posts/106

https://justhackem.wordpress.com/2018/01/30/writing-git-commit-messages-using-vscode/

https://code.visualstudio.com/blogs/2020/05/06/github-issues-integration

Commit message 7가지 규칙

1. 제목과 본문을 한 줄 띄어 구분
2. 제목은 50자 이내
3. 제목 첫 글자는 대문자
4. 제목 끝에 마침표 X
5. 제목은 명령문으로, 과거형 X
6. 본문의 각 행은 72자 이내 (줄바꿈 사용)
7. 본문은 어떻게 보다 무엇을, 왜에 대하여 설명

제목 Type

• feat : 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정
• fix : 기능에 대한 버그 수정
• build : 빌드 관련 수정
• chore : 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
• ci : CI 관련 설정 수정
• docs : 문서(주석) 수정
• style : 코드 스타일, 포맷팅에 대한 수정
• refactor : 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경
• test : 테스트 코드 추가/수정
• release : 버전 릴리즈

(이건 소문자)

 

Subject

Type 과 함께 헤더를 구성합니다. 예를들어, 로그인 API 를 추가했다면 다음과 같이 구성할 수 있습니다.

ex) feat: Add login api

대문자로 시작하는 것이 좋다.

Body

헤더로 표현이 가능하다면 생략이 가능합니다. 아닌 경우에는 자세한 내용을 함께 적어 본문을 구성합니다.

Footer

어떠한 이슈에 대한 commit 인지 issue number 를 포함합니다. 위의 좋은 예시에서는 (#1) 처럼 포함시켰습니다. 그리고 close #1 처럼 close 를 통해 해당 이슈를 닫는 방법도 있습니다.

=> 키워드 #이슈번호 로 이슈를 닫음.

close, closes, fix, resolve 등등...의 키워드 사용 => 어디에 쓰던지 상관없음.

 

푸시한 브랜치에 따라 이슈가 자동으로 닫힘.

.gitignore

# : comments

# no .a files
*.a

# but do track lib.a, even though you're ignoring .a files above
!lib.a

# only ignore the TODO file in the current directory, not subdir/TODO
/TODO

# ignore all files in the build/ directory
build/

# ignore doc/notes.txt, but not doc/server/arch.txt
doc/*.txt

# ignore all .pdf files in the doc/ directory
doc/**/*.pdf