Skip to content

Git & Github 컨벤션

Park Dongseok edited this page Dec 18, 2022 · 7 revisions

Commit Convention

<작업 타입>: <작업 내용>


feat: 기능, UI 작업 추가
fix: 버그 수정, 잘못된 코드 개선
refactor: 코드 리팩토링(로직의 변경없이 함수 분리, 컴포넌트 분리, 코드퀄리티 향상 작업 등)
chore: 패키지 매니저(`EX: packgage.json`) 추가/수정
style: 로직 변경 없는 단순 스타일적인 구조 변경, 수정 (`EX: 개행, 세미콜론 까먹은거 추가 등`)
docs: 문서 작업
build: ci/cd 등 배포 관련 작업

EX) feat: Header Component에 회원 인증 상태 관리 기능 추가


커밋 제목

  • 작업내용을 대표할 수 있도록 내용을 작성
  • 개조식으로 작성 (~했다. 금지)

커밋 바디

  • 커밋 제목으로 작업내용을 대표하지 못한다고 판단될 때 자율적으로 작성

기타

  • 틀려도 괜찮으니 고민하고 잘 시도해보기

Pull Request

  • 제목은 최대한 본인이 한 작업을 대표하여 설명할 수 있도록 작성해볼 것!
  • (선택)내용에는 무엇을 했는지 등을 기록해보고 싶다면 할 것

Gitflow 순한맛

Branch

  • maseter: 실제 배포 브랜치(상시유지)
  • dev: 개발용 브랜치(상시유지)
  • feat: 기능 개발 브랜치
  • hotfix: 프로덕션 버그/에러 해결 브랜치
  • master, dev 브랜치에 직접 작업하지 않기

피쳐 브랜치 네이밍

feat/이니셜/작업주제 :예 feat/pds/postdetail-page-ui


흐름

  • fork 없이 이 repositoryclone하여 공동 사용

  • 시간관계상 issue 발행 제외

  • 한 단위의 작업에 대해 브랜치를 만들고 Pull Request하기

  • 코드리뷰 간략하게 진행 (github가 권장되나 어떤 방식이든 👍 )

  • 수정사항이 있다면 반영 후 push => 재리뷰

  • 자신의 pr은 자신이 develop 브랜치에 merge 하기

Project

Rule

학습 & 트러블 슈팅일지


일일 할일 목록 체크리스트

Clone this wiki locally