Skip to content

Convention

im-hayeon edited this page Feb 25, 2023 · 2 revisions

브랜치 컨벤션

  • Feature Branch 전략을 따라 main, develop, feature 브랜치를 갖는다.
  • develop 브랜치를 default branch로 설정하고 개발한다.
  • develop 브랜치에서 기능 단위의 feature 브랜치를 생성한다.

브랜치 네이밍

  • feature 브랜치 명은 feature/이슈 번호와 같이 작성한다.
  • ex) feature/1, feature/2 ...

커밋 컨벤션

[#이슈번호] type: 커밋 메시지

type

#   [커밋 타입]  리스트
#   feat      : 기능 (새로운 기능)
#   fix       : 버그 (버그 수정)
#   design    : CSS 등 사용자 UI 디자인 변경
#   refactor  : 리팩토링
#   style     : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
#   docs      : 문서 (문서 추가, 수정, 삭제)
#   test      : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore     : 기타 변경사항 (빌드 스크립트 수정 등)
#   rename    : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 하는 경우
#   remove    : 파일을 삭제하는 작업만 수행한 경우

이슈 템플릿

제목: tag: 구현할 기능

<!-- 제목 양식 // prefix: 구현할 기능 -->

## ⭐ 주요 기능 <!-- 구현할 기능(목표)에 대한 간략한 설명 -->

## 📋 진행 사항

- [ ] TO-DO 1
- [ ] TO-DO 2

## 📄 참고 사항

PR 템플릿

제목: tag: 작성한 이슈와 동일한 제목

<!--🚨 PR 날리기 전에 develop 브랜치에 merge하는지 확인해주세요!-->
<!-- 제목 양식 // 커밋타입: 작성한 이슈와 동일한 제목 -->
<!-- ex) feat: 로그인 기능 구현 -->
<!--제목의 형식이 알맞은지 확인해주세요!-->

## ⭐ 개요

작업내역명(페이지명)

## 📋 작업사항

- [ ] 작업내용
- [ ] 작업내용

## 😉 참고사항

<!--팀원들이 참고해야할 사항이 있으면 작성해주세요-->

## 💻 스크린샷

<!-- 이미지나 작업내용을 공유해주세요 -->

Closes #{이슈 번호}
  • 마지막 Closes #{이슈번호}에 이슈 번호를 달아 주게 되면 (ex: Closes#122) 해당 이슈가 자동으로 클로즈 되게 됩니다!
Clone this wiki locally