git conventions

git flow branches

master
|-- release:배포한 버전
    |-- develop: 개발하고 있는 버전
        |-- HW
            |-- feature/face-detection: 세부 구현 모듈
        |-- FE
            |-- feature/log-in
        |-- BE

(branch) /folder

• (master)
  • /DOCS/ideas: 모두가 볼 기획 내용, total architecture, ERD 등
  • /DOCS/tips: 모두가 볼 팁
• (HW)
  • /HW/DOCS/ideas: HW가 볼 기획 내용
  • /HW/DOCS/tips: HW 볼 팁 내용
  • /HW: 개발 내용을 dir 등 사용하여 기재
• (FE)
  • /FE/DOCS/ideas: FE가 볼 기획 내용
  • /FE/DOCS/tips: FE가 볼 팁 내용
  • /FE: 개발 내용을 dir 등 사용하여 기재
• (BE)
  • /BE/DOCS/ideas: BE가 볼 기획 내용
  • /BE/DOCS/tips: BE가 볼 팁 내용
  • /BE: 개발 내용을 dir 등 사용하여 기재

유의 사항

• git add . 사용 지양

  • git add 할 때 혹시 내가 삭제하면 안 되는 파일을 삭제했을 수도 있으니까 본인이 바꾼 파일만 git add ./바꾼 파일 하는 게 좋음(merge 시 충돌 방지)

    $ git add ./새로운 폴더/*                // 새로운 폴더 + 폴더 내 내용 들어감
    $ git add ./바꾼 파일(혹은 새로운 파일)  // 바꾼 파일 들어감
    

• 혹시 모르니 기본 개발은 git dir 이 아닌 다른 폴더에서 진행 후 다 된 사항을 git dir에 옮기는 것도 방법

• 다른 사람이 쓰고 있는 feature branch를 가능한 같이 사용하지 않기!

• 해당 feature가 다 개발되고 나면 merge&feature branch 삭제

Commit message

YYMMDD [jira 이슈 번호] 첫 글자 대문자, 명령형 제목

type: feat,fix,docs, style,refactor,test,chore 중 택 1

변경한 내용, 이유 포함 본문, 72자마다 새로운 줄

• FEAT : 새로운 기능의 추가
• FIX: 버그 수정
• DOCS: 문서 수정
• STYLE: 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
• REFACTOR: 코드 리팩토링
• TEST: 테스트 코드, 리팩토링 테스트 코드 추가
• CHORE: 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)
• TIPS: 개발에 도움이 되는 내용

예시

• jira 이슈 BOBI-12 기록할 곳 정하기 에 관련된 commit 작성 시

220714 [#12] Fix writing rule

- type: CHORE
- Writing rule was not fixed

template.txt

################
# #으로 시작하는 부분은 commit에 반영되지 않음
# YYMMDD [jira 이슈 번호] 제목의 형식으로 제목을 아래 공백줄에 작성
# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
# 첫 글자 대문자
# 예) 220714 [#14] Fix writing rule
# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)
################
# [제목쓰는 란]


################
# 본문(구체적인 내용)을 아랫줄에 작성
# 이전에 어떤 문제가 있었는지, 왜 바꿨는지 얘기
# 무엇을 바꿨는지 얘기
# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
# - type: 대문자로 작성
# - 자세한 내용
# FEAT : 새로운 기능 추가
# FIX : 버그 수정
# DOCS : 문서 수정
# TEST : 테스트 코드 추가
# REFACT : 코드 리팩토링
# STYLE : 코드 의미에 영향을 주지 않는 변경사항
# CHORE : 빌드 부분 혹은 패키지 매니저 수정사항
# TIPS: 개발에 도움이 되는 내용
# 
# 예) - type: CHORE
      - Writing rule was not fixed
			- Mention where to write proceedings, members information etc
################
# [본문 쓰는 란]

git config --global commit.template ./.gitmessage.txt

last modified on 18 Aug, 2022