Convention & Git Flow

Commit Convention

AngularJS Git Commit Message Conventions

• feat : 새로운 기능 추가
• fix : 버그 수정
• style : 컴포넌트 스타일 및 테마 변경 등의 수정 사항
• setting : Eslint, dependency, config 파일 등의 수정 사항
• docs : README 파일 수정 등 문서 작업
• chore : 화면 및 로직의 변화가 없는 작업(ex: 파일 구조 변경)

git commit -m “feat: Footer Component 구현”

git commit -m “setting: lint fix”

Git Flow

1. 작업은 항상 master에서 분기한 develop 브랜치에서 브랜치를 분기하여 작업합니다.
2. 브랜치 이름은 [actions]-[기능명] 처럼 하이픈으로 구분합니다. (ex. feat-login-api)
3. 작업이 끝난 후 develop 브랜치를 pull 받아 conflict 여부를 확인합니다.
4. conflict가 발생했다면 해결하고, 그렇지 않다면 develop 브랜치로 Pull Request 요청을 합니다.
5. 모든 Pull Request는 팀원들의 리뷰를 거친 뒤 merge합니다.
6. develop 브랜치로 모든 작업 사항들이 합쳐지면 master 브랜치로 merge합니다.

기본 커맨드 설명

# 현재 브랜치 확인 (확인 후 키보드에서 q(큐) 누르면 됨)
git branch

# 브랜치 생성
git branch 브랜치이름

# 브랜치 선택(이동) 
git checkout 브랜치이름

# 브랜치 삭제
git branch -d 브랜치이름

Flow 예시

1. master 브랜치에서 develop 브랜치 생성

   # 현재 브랜치 확인
   git branch
   
   # 1. 현재 브랜치가 master인 경우, 바로 dev 생성 
   git branch develop 
   
   # 2. 현재 브랜치가 master가 아닌 경우, 일단 master로 전환한 후 dev 만듦.
   git checkout master
   git branch develop

2. develop 브랜치에서 feat 브랜치 생성 - 브랜치 이름은 아래의 actions에서 작업에 적합한 prefix로 설정

   # 현재 브랜치 확인 (별표 붙어있는 것)
   git branch
   
   # 1. 현재 브랜치가 dev인 경우, 바로 feat 생성 
   git branch feat-admin-page
   
   # 2. 현재 브랜치가 dev가 아닌 경우, 일단 dev로 전환한 후 feat 만듦.
   git checkout dev
   git branch feat-admin-page

3. feat 브랜치에서 개발 진행 (로컬)

   # 현재 브랜치 확인 (별표 붙어있는 것)
   git branch
   
   # 1. 현재 브랜치가 feat-admin-page인 경우, 해당 브랜치에서 개발 진행
   
   # 2. 현재 브랜치가 feat-admin-page가 아닌 경우, 일단 feat-admin-page로 전환한 후 개발함
   git checkout feat-admin-page

4. feat 브랜치에서 개발 완료 -> develop 브랜치 pull 받아서 conflict 확인

   # 1. develop 브랜치 pull 받아오기
   git pull origin develop
   
   # 2. 변경 사항이 없거나 conflict가 발생하지 않는 경우 바로 push
   git push origin 브랜치이름
   
   # 3. conflict가 발생한 경우 conflict 해결 후 push
   git push origin 브랜치이름

actions

• feat : 새로운 기능 추가작업 브랜치
• fix : 기능 수정중인 브랜치
• refactor : 코드 구조 수정중인 브랜치

ISSUE

• 개발 간 이슈 발생 시 Issues 탭에 등록하여 문제를 공유합니다.