본문 바로가기
ssafy 공통프로젝트

컨벤션

by 펀구구 2023. 7. 26.

Commit 메시지 컨벤션

규칙

  1. 메시지는 한글로 작성
  2. 제목은 명사로 끝내기
  3. ex) 회원 가입 구현함(X) → 회원 가입 구현 완료(O)
  4. 마침표 사용하지 않기
  5. 제목과 본문은 빈 행으로 구분하기
  6. 제목의 타입은 소문자로 작성
  7. 본문의 내용은 어떻게 보다는 ‘**무엇과 왜’**에 중점
  8. Gitmoji 사용하기(Gitmoji 사용 후 한 칸 띄우기)
    • Gitmoji npm 설치 명령어
    • npm i -g gitmoji-cli
  9. Gitmoji 사용하기

구조

:gitmoji: 타입: 제목

본문

// 예시
✨ feat: 회원가입 기능 구현

유효성 검사 로직 추가
아이디 중복확인 로직 추가

Gitmoji 및 타입 설명

Icon 코드 타입 설명

🎉 :tada: init 프로젝트 시작
:sparkles: feat 기능 추가/수정
🐛 :bug: fix 버그 수정
💄 :lipstick: design CSS 등 사용자 UI 디자인 추가/수정
🎨 :art: style 스타일 수정(공백, 세미콜론 등)
📝 :memo: docs 문서 수정
♻️ :recycle: refactor 코드 리팩토링
:white_check_mark: test 테스트 추가
👷 :construction_worker: chore 빌드, 패키지 관련(업데이트 등)
🚚 :truck: rename 파일/폴더 이동, 이름 수정

브랜치 전략

GitLab flow(방식) & Git flow(브랜치명) 차용

  • master: 최종 배포 브랜치(절대 오류 발생 X)
  • dev-back, dev-front: 백엔드, 프론트 각각 합치는 브랜치(develop 브랜치 역할)
  • feature/back/기능: 기능 개발 하는 브랜치

브랜치 네이밍

  • feature/역할/기능요약 형식으로 정한다. ex) feature/front/home, feature/back/login
  • Merge한 다음에는 로컬, 리모트에서 둘 다 브랜치 삭제한 후 다시 같은 이름 재사용

브랜치 머지 방식

  • 단순 Merge 방식

[Git] Merge 이해하기 (Merge / Squash and Merge / Rebase and Merge)

master 업로드 주기

  • 최소한 하루에 한번씩!!
  • 저녁 스크럼 전에
  • develop에 새로운 게 있으면 합쳐보기
  • 퇴근을 앞두고 오류 때문에 업로드를 하지 못하면 feature 브랜치에 push하기(master 브랜치 X)

기타 정리 사항

  • 로컬에 pull 할 때는 develop 기준
  • 완벽하게 구현된 것은 master로 보내기
  • PR 승인 시, 간단한 코드 리뷰 진행하기
  • Jira에서 이슈 관리하기