Git 컨벤션

이번 포스팅에서는 좋은 커밋 메세지를 작성하는 법, 
대표적 lint 규칙,
브랜치 이름 규칙 등에 대해서 공부하겠습니다. 

 

커밋 메세지 규칙

• 제목 + 본문으로 작성, 제목만 작성해도 된다. 

 

제목 작성하기 

• 제목 태그 : 본문
• 영문 기준 50자 이내 제목 추천
• 영문 기준 동사(원형) 가장 앞, 과거 시제 x
• 제목 첫글자 대문자
• 제목 끝 . 금지
• 명령어, 개조식으로 작성

제목 태그 종류 

제목 태그 이름	설명
Feat	새로운 기능 추가
Fix	버그 수정
Design	CSS 등 UI 디자인 변경
!BREAKING CHANGE	커다란 API 변경
!HOTFIX	긴급 오류 수정
Style	코드 포맷 변경, 세미콜론 누락
Refactor	코드 리팩토링
Comment	필요한 주석 추가
Docs	문서 수정
Test	테스트 추가 및 리팩토링
Chore	빌드 테스트 업데이트, 패키지 매니저  설정
Rename	파일 혹은 폴더명 수정
Remove	파일 삭제

 

본문 작성하기

• 선택사항
• 무엇을 왜 변경하였는가? 에 초점을 맞추기 
  
  

꼬리말 작성하기 

• 선택사항
• issue tracker id
• 유형: #이슈 번호 

유형 작성하기

이슈 트래커 유형	설명 (아직 해결 x)
Fixes	이슈 수정 중
Resolves	이슈 해결
Ref	참고할 이슈 있을 때
Related to	해당 커밋에 관련된 이슈 번호 (아직 해결 x)

 

커밋 예시 

Feat: "로그인 기능 구현"  

새로고침 시 로그인 유지 기능 개발 

Resolves: #67
Ref: #64
Related to: #33, #34

 

Lint 규칙

코드의 오류나 버그, 스타일 따위를 점검하기 위한 규칙

• 에어비앤비
  https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base
• esLint
  https://eslint.org/
  
  
• standard
  https://github.com/standard/eslint-config-standard
  
  
• semistandard
  https://www.npmjs.com/package/semistandard
  
  
• prettier

 

브랜치 이름 형식

종류	사용패턴	특징
main	main	프로덕션 스냇샷 가장 최신의 배포된 버전
dev	dev	릴리즈 계획에 따라 Github에서 기본  브랜치로 지정
feature	feature/이슈번호- 이름	dev 병합
hotfix	hotfix/이슈번호	main 병합