Git Commit Convention

🔴 Git commit Convention

 그동안 프로젝트를 진행하면서 Github를 사용하여 팀 협업 및 형상관리를 진행하였습니다. 작업 내용을 추가하고 수정하고 삭제하는 과정을 기록하고 그 과정을 commit을 통해 log를 남기고 push를 하였습니다.

 하지만 바쁘게 프로젝트를 수행하였기 때문에 commit방식보다 프로젝트 구현에 신경을 쓰게 되어 commit rule에 대해 정해 놓지 않아 무분별한 commit을 하는 경우가 다반사였습니다.

 git Commit을 작성할 때 잘 작성해야 효율적인 팀 협업을 할 수 있겠다는 생각을 하게 되었습니다. 이로 인해 Git Commit Convention을 알게 되었고 이를 통한 규칙을 정해 commit하는 방법을 알아보겠습니다.

그 동안 위의 방식(update , add , delete)와 같은 동사를 앞에 붙여 commit을 날리곤 했었다.

🟠 Conventional Commits

사실 commit방식에 대해서는 군데군데 조금씩의 차이는 있을 것이라고 생각합니다. 하지만 보통 Udacity에서 이를 인지하고 가이드를 제시하고 있었습니다.

Udacity commit

기본적인 규칙

[type]: description -> 제목
[optional body] -> 본문
[optional footer(s)] -> 꼬리말

자세한 내용은 나중에 알아보고, 대충이러한 구조라고 생각하면 됩니다.

type

Feat : 코드에 새로운 기능을 도입
Fix : 코드에서의 버그를 패치
Refactor : 코드 리팩토링
Design : CSS 및 UI/UX수정
Comment : 코드에서의 주석 추가
Rename : 코드 파일이나 폴더를 수정
Remove : 코드 파일이나 폴더를 삭제

제목에서의 rule

마침표 및 특수기호 사용x
첫 글자 대문자, 명령문 사용
개조식 구성
최대 50글자 넘지 않기

본문에서의 rule

선택사항이기 때문에 꼭 작성할 필요는 없으나 필요한 경우에 작성
어떻게 보다는 무엇을,왜에 중점을 놓고 작성
한 줄당 72자 내로 작성
최대한 상세히 작성

footer rule

이것도 선택사항이기 때문에 꼭 작성할 필요는 없다.
issue tracker id를 작성할 때 사용한다.

🟠 Example

Feattype : Add login Modal Functionsubject

기존의 adminPage에서 로그인 창 이동 후 로그인 하는 방식에서 로그인 버튼을 누르면 modal이 열리고 그 modal에서 로그인 form을 통해 로그인을 할 수 있게 로직을 구현했습니다. body

Resolves : #231Footer

Reference
https://udacity.github.io/git-styleguide/
https://webruden.tistory.com/486
https://meetup.nhncloud.com/posts/106

👍올바른 피드백은 언제든지 환영입니다~!