Skip to content

Latest commit

 

History

History
147 lines (92 loc) · 4.81 KB

CONVENTION.md

File metadata and controls

147 lines (92 loc) · 4.81 KB
Raw

Convention

  • CONVENTION.md파일에 포함되는 내용은 프로젝트에서 사용하는 Git 사용법을 정리했어요.
  • 아래 내용을 확인하고 작업할 때 참고해주세요.

Table of contents

Git convention

  1. 기본적으로 우리는 Git-flow 방식으로 GitHub 프로젝트를 관리합니다.
  2. Git-flow 방식은 GitHub 버전 컨트롤 방법 중 하나이며, 작업 인원이나 작업분량에 따라 브랜치를 분기합니다.
  3. Main 브랜치는 검증이 완료되어 어디에서든지 프로덕션이 가능한 상태여야 해요.
  4. Main 브랜치에 내용이 병합되기 전에 Test 브랜치를 거쳐 다 같이 검증을 해야해요.
  5. 결과적으로 Test 브랜치는 결함이 없을 때, Main 브랜치에 병합이 가능해요.

Branch 생성하기

브랜치 생성, 분기 그리고 병합과 관련한 내용을 포함합니다.

1.1. feat/mirae-issue-number

  • 신규 기능을 작업하기 위한 Feature 이슈가 등록되면 해당 브랜치를 생성합니다.
  • 여기서 mirae는 자신의 이름입니다.
git branch # 현재 HEAD가 어디를 가리키고 있는지 브랜치를 먼저 확인합니다.
git branch feat/mirae-1 # 브랜치를 생성하고 스위치합니다.

1.2. refactor/mirae-issue-number

  • 프로젝트 내부 구조를 재정의 하거나 유지보수가 필요한 작업 시 해당 브랜치를 생성합니다.
git branch # 현재 HEAD가 어디를 가리키고 있는지 브랜치를 먼저 확인합니다.

git branch refactor/mirae-2 # 브랜치를 생성하고 스위치합니다.

1.3. hotfix/mirae-issue-number

  • 프로젝트 오류나 문제가 발생할 때 빠르게 수정하기 위해 생성하는 브랜치입니다.
git branch # 현재 HEAD가 어디를 가리키고 있는지 브랜치를 먼저 확인합니다.

git branch hotfix/mirae-3

1.4. test/drive-number

  • 작업한 개인 브랜치를 병합하고 통합 테스트를 진행하기 위한 브랜치입니다.
git branch # 현재 HEAD가 어디를 가리키고 있는지 브랜치를 먼저 확인합니다.

git branch -d test/drive-number # 예) drive-1

1.5. styl/mirae-issue-number

  • 작업한 개인 브랜치를 병합하고 통합 테스트를 진행하기 위한 브랜치입니다.
git branch # 현재 HEAD가 어디를 가리키고 있는지 브랜치를 먼저 확인합니다.

git branch -d styl/mirae-4 # 예) drive-1

Commit convention

  • 커밋 메세지는 type: subject 형식으로 작성합니다. 이때 spacing은 : 앞에 한 번만 사용합니다.
  • :(콜론)은 type에 붙여서 사용하고 subject와는 간격을 두어야 합니다.
  • subject 작성 시 첫 단어로 영어를 사용할 경우 반드시 대문자로 시작해야 하며, 다음 단어는 spacing후 소문자로 작성합니다.
  • 메세지를 끝맺을 때 ., !, -, ?와 같은 마침표 문자를 사용하지 않습니다.
  • #n문자는 연결된 이슈가 있으면 사용합니다. 이때 #n은 이슈 번호입니다.
  • delete 구분자는 파일을 완전히 삭제할 때 사용합니다. 파일 내용 중 일부분을 변경한거라면 modified를 사용합니다.

1.표기법 예시

1.1. add:

  • 파일 또는 새로운 작업 내용을 추가할 때 사용하는 구분자입니다.
git commit -m "add: 구글 로그인 서비스"

git commit -m "add(api): #n 구글 로그인"

1.2. feat:

  • 기능을 구현했을 때 사용하는 구분자입니다.
git commit -m "feat: #n 구글 로그인"

git commit -m "feat(function): #n 구글 로그인"

1.3. modified:

  • 파일 내용을 변경할 때 사용하는 구분자입니다.
  • 만약 프로젝트에서 완전히 삭제되는 파일 또는 내용인 경우 delete: 구분자를 사용하세요.
git commit -m "modified: 사용자 목록"

git commit -m "modified(component): #n 사용자 목록"

1.4. delete:

  • 파일을 완전히 삭제하거나 내용 중 일부분 삭제하는 경우 사용합니다.
git commit -m "delete: 사용자 계정 아바타 아이콘"

git commit -m "delete(asset): #n 사용자 계정 아바타 아이콘"

1.5. fix:

  • 파일의 치명적인 문제를 해결할 때 사용하는 구분자입니다.
git commit -m "fix: Pagination 애니메이션 오류"

git commit -m "fix(component): #n Pagination 애니메이션 오류"

2.혼용 표기법

  • 한/영단어를 섞어 사용해도 좋지만, 되도록 한글 또는 영문으로 표기하는 것을 추천합니다.
git commit -m "add(file): #n CONVENTION 문서"

git commit -m "modified(function): #n 이벤트 삭제 처리"

git commit -m "delete(component): #n Footer 컴포넌트 삭제"