Doc : git - Repository 설정

[yunah7]

📃 이슈 내용

• git 환경 설정

✏️ 상세 내용

• [x] pull request template 등록
• [x] issue template 등록
• [x] issue label 설정
• [x] branch protection 설정

➕ 기타 사항

• commit message는 댓글로 공유하겠습니다

[yunah7]

issue

issue label

• Feature : 기능 관련 커밋
• Bug : 버그 관련 커밋 (기능과 분리하여 작성합니다.)
• Document : git 관련, 플랫폼 환경 설정 관련 커밋
• Improve : 기능 개선 요청 관련 커밋
• help wanted : 도움 요청 관련 커밋

writing issue

• 제목 통일 필요, Assign, label 지정 필요

[yunah7]

Pull Request

writing pull request

• 제목 작성 시 issue num 태그 필요, 제목은 issue 제목과 동일하게 작성

• 내용 작성 시, 변경 내용을 코드를 포함해 자세히 설명

• 하단 부에, 변경 내용에 대한 설명 외 부가적인 설명 필요하면 작성

• 이슈 태그 필요

pull request comment

• 꼭 file change의 review 기능을 통해 comment 작성
• review 반영 이후엔 comment에 변경 사항 재작성

[yunah7]

Branch

Branch naming

• default 겸 최종 브랜치 : main
• 기능 구현 : feature/
• 버그 : Bug/
• 문서 : document/
• 기능 개선 : improve/
• 도움 요청 : help/

ex) 5번째 이슈에 대한 기능 구현 -> feature/5 로 브랜치 생성하여 수행

Branch protection

• 2인 이상(전체)의 approve를 받아야 merge 권한 부여

[yunah7]

Commit

• 모든 커밋은 main이 아닌 작업 중인 branch로 커밋하여 pull request를 작성하여야 함
• 커밋 시 issue 태그
• 제목과 내용을 분리해 작성

commit message

################
# 타입 종류
# Feat: 새로운 기능을 추가
# Fix: 버그 수정
# Design CSS 등 사용자 UI 디자인 변경
# !BREAKING CHANGE 커다란 API 변경의 경우
# !HOTFIX 급하게 치명적인 버그를 고쳐야하는 경우
# Style 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
# Refactor 프로덕션 코드 리팩토링
# Comment 필요한 주석 추가 및 변경
# Docs 문서 수정
# Test 테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음
# Chore 빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, Production Code 변경 없음
# Rename 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
# Remove 파일을 삭제하는 작업만 수행한 경우
################
# <타입>: <제목> 의 형식으로 제목(title)을 아래 공백줄에 작성
# :(space)제목 으로 :뒤에만 space를 넣는다
# 제목은 50자 이내 / 과거시제는 사용하지 않는다 / 마침표 및 특수기호는 사용하지 않는다
# 예) feat: 로그인 기능 추가

# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)

################
# 본문(구체적인 내용)을 아랫줄에 작성
# 어떻게 변경했는지보다 무엇을, 왜 변경했는지 작성한다

# 바로 아래 공백은 지우지 마세요 (본문과 꼬릿말의 분리를 위함)

################
# 유형 종류
# Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
# Resolves: 이슈를 해결했을 때 사용
# Ref: 참고할 이슈가 있을 때 사용
# Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
################
# <유형>: #<이슈번호> 형식으로 꼬릿말(footer)을 아랫줄에 작성
# 여러 개의 이슈번호는 쉼표(,)로 구분한다.
# 예) Fixes #7