Skip to content

Github Convention

이정욱 edited this page Dec 3, 2022 · 2 revisions

🇰🇷 커밋 컨벤션

  • 한글로 커밋한다.
  • 타입은 영어로 작성하고 커밋 메시지는 한글로 작성한다.
  • 제목 끝에 마침표(.) 금지
  • 괄호 뒤에 공백 필수!

커밋 메시지 예시

ex `[Feat] 갤러리 버튼 추가`

커밋 타입 리스트

타입 설명
feat 기능 추가 시
modify 기능 수정 시
fix 버그 수정 시
refactor 기능은 동일, 리팩토링
chore 기타 변경사항(외부 config파일 수정,빌드수정, npm install 등)
design 디자인(css) 수정
style 세미콜론 등 간단한 수정 (변수명 변경, eslint 빼먹은거 적용 등)
docs 문서 추가, 수정, 삭제
test 테스트 코드 추가, 수정, 삭제

🕺 PR 컨벤션

Summary(한 일 요약),Context(하게된 배경),Description(어떤 것들을 했는지)을 PR에 적는다. PR 예시

## Summary 
  노션 Oauth 연결 API를 개발하였습니다.
## Context
  노션의 페이지 컨텐츠를 얻어오기 위함
## Description
  redirection URL, clientId,client Secret 값 설정
  authrization code getter 구현
  access token getter 구현

🚥 git flow, Branch 전략

branch 타입 리스트

타입 설명
main 현재 배포중인 브랜치(안정화 버전) ⇒ 자동 배포 적용
develop 다음 출시 버전을 개발하는 브랜치
hotfix 출시 버전에서 발생한 버그를 수정 하는 브랜치 (버그 픽스 후 main으로 merge)
feat/[*] 기능을 개발하는 브랜치

feat 브랜치에서, 세부기능 개발 시에는 - 를 활용한다.

branch 예시

feat/character-move 
스프린트 계획 회의
🕖 데일리 회의
week1
week2
week3
week4
week5
week6
📔 팀 회고
🗓 개인 회고
🏝️Ground Rule
⚙️ Tech Spec
Clone this wiki locally