1. Git Convention

깃 컨벤션 요약

1.1. 브랜치명 예시

• dev/브랜치명 카테고리-작업 내용
  • dev/feat-main-view
  • dev/add-font-res

1.2. 브랜치명 카테고리

• feat : 구현
• mod : 수정
• add : 추가
• del : 삭제
• fix : 버그 수정
• refactor : 리팩토링

2.1. 커밋 예시

• [커밋 카테고리] #이슈번호 커밋 내용
  • [feat] #500 홈 뷰 구현
  • [feat] #500 로그인 서버 연동
  • [mod] #500 회원가입 로직 변경
  • [del] #500 불필요한 import 제거
  • [mod] #500 MainActivity 코드 정렬 적용
  • [fix] #500 회원가입 버튼 활성화 로직 버그 수정

2.2. 커밋 카테고리

• feat : 새로운 기능 구현
• mod : 코드 수정
• add : feat 이외의 부수적인 코드 추가, 라이브러리 추가
• del : 쓸모없는 코드 삭제
• chore : 변수명 및 함수명 수정과 같은 사소한 수정
• fix : 버그 수정
• docs : 문서 추가, 수정, 삭제
• init : 프로젝트 초기 세팅

3.1. Git Flow

기본적으로 Git Flow 전략을 이용한다. 작업 시작 시 선행되어야 할 작업은 다음과 같다.

1. Issue를 생성한다.
2. feature Branch를 생성한다.
3. Add - Commit - Push - Pull Request 의 과정을 거친다.
4. Pull Request가 작성되면 작성자 이외의 다른 팀원이 Code Review를 한다.
5. Code Review가 완료되면 Pull Request 작성자가 dev Branch로 merge 한다.
6. merge된 작업이 있을 경우, 다른 브랜치에서 작업을 진행 중이던 개발자는 본인의 브랜치로 merge된 작업을 Pull 받아온다.
7. 종료된 Issue와 Pull Request의 Label과 Project를 관리한다.

3.2. Etc

협업 시 준수해야 할 규칙은 다음과 같다.

1. dev에서의 작업은 원칙적으로 금지한다. 단, 초기 세팅 및 README 작성은 dev Branch에서 수행한다.
2. 자신이 담당한 부분 이외에 다른 팀원이 담당한 부분을 수정할 때에는 Slack을 통해 변경 사항을 전달한다.
3. 본인의 Pull Request는 본인이 Merge한다.
4. Commit, Push, Merge, Pull Request 등 모든 작업은 앱이 정상적으로 실행되는 지 확인 후 수행한다.
5. README 수정 및 ktlint 적용을 위한 Commit 도배는 금지한다. 리드미 미리보기는 Preview를 통해 확인한다.

3.3 Detail

1. 깃헙에서 이슈 파기

- 이슈는 현업 프로젝트가 프로젝트가 아닌, 앱잼 프로젝트이기 때문에 큰 단위로 가져가자
- 타이틀 예시) `[feat] 홈 뷰 구현하기`

2. 이슈를 판 후 안스에서 local에 있는 dev로 체크아웃 및 최신화(update)를 적용

1. git 탭 > dev 브랜치 우클릭 > update 또는
2. git fetch origin dev

3. 현재 local의 dev 브랜치에서 작업할 브랜치 파기

4. 작업 및 커밋하기

1. 커밋은 잘게 쪼게서 하는 연습하기!
2. 커밋 내용별로 카테고리 [prefix] 잘 붙여주기!
3. 작업 끝나면 PR을 올리지 않더라도 항상 push까지 해주기

5. Push 하기

Push전 dev 브랜치에 최신 변경사항이 있는지 확인하고 있다면 dev브랜치의 변경사항을 현재 작업 브랜치로 머지하기!

1. 하단 git 탭 > dev 브랜치 우클릭 > update 후
2. 하단 git 탭 > dev 브랜치 우클릭 > Merge  dev into ‘현재 작업 브랜치’
3. a, b 대신에 git pull origin dev 실행 가능
4. 머지한 내용이 프로젝트에서 잘 실행되는지 확인하기
5. Push 하기

6. PR 작성

7. Merge하기

1. 다른 팀원 코드리뷰 받고, 반영할 내용이 있다면 반영하기!
2. 최소 한명이상의 팀원에게 approve를 받은 경우 본인이 Merge한다.