[규칙] 프로젝트 수행 시 필요한 규칙

[yeonns2]

[규칙 정하기]

우리는 Feature Branch Workflow로 협업합니다 ! Feature Branch WorkFlow란?

1. Commit 메시지 컨벤션
2. Branch 이름
3. Merge 규칙
4. Issue 규칙

[yeonns2]

1. Commit 메시지 컨벤션

• feat : 새로운 기능 추가
• fix : 버그 수정
• docs : 문서 수정
• style : 코드 포맷팅, 세미콜론 누락,코드 변경이 없는 경우
• refactor : 코드 리팩토링
• test : 테스트 코드,리팩토링 테스트 코드 추가
• chore : 빌드 업무 수정, 패키지 매니저 수정

[yeonns2]

2. Branch 이름 규칙

• main branch
  • 배포용 브랜치
• develop branch
  • 다음 출시 버전 개발 브랜치
• feature branch
  • 기능을 개발하는 브랜치
  • feature/기능요약 ex) feature/login
• release branch
  • 이번 출시 버전을 준비하는 브랜치
• hotfix branch
  • 출시 버전에서 발생한 버그를 수정하는 브랜치

더 자세한 브랜치 네이밍 규칙은 이걸 참고하면 좋아요

[yeonns2]

3. Merge 규칙

브랜치 merge 전 아래 과정을 반드시 진행한다.

1. 개인이 작업한 브랜치를 원격 저장소에 push한 후 Pull requests 를 작성한다.
2. 다른 팀원들이 Pull requests 를 확인하고, 코드에 대한 리뷰를 작성한다.
3. 팀원들이 수정을 요청하면 로컬에서 수정 후 다시 push하고, 수정 완료를 댓글로 공지한다.
4. 팀원들이 모두 merge에 동의하면, 해당되는 원격 브랜치에 merge한다.

[yeonns2]

4. Issue 규칙

1. 모든 이슈는 목적에 따라 적절한 레이블을 붙인다. 기본 레이블은 issue이다.
   다음 내용에 관한 이슈는 머릿말을 붙인다.
   [problem]
   [solve]
   [bug]
   [question]
2. 코드에 관한 이슈는 머릿말을 붙인다.
3. 해결된 이슈는 close한다.
4. bug/problem/question 관련 레이블이 붙은 이슈는 solve 레이블을 추가한 후 close한다.