Skip to content

공통‐깃허브 컨벤션

ashsty edited this page Jul 19, 2024 · 11 revisions

💻 커밋 컨벤션

# 예시
git commit -m "<type>: 커밋 내용"

type 항목

  • docs : 문서 관련 ( README , Open API )
  • feat : 새로운 기능 추가
    • 기능 + 테스트코드 같이 커밋
    • 기능 변경이 목적일 경우
    • 요구사항 변경으로 인한 함수의 역할이 바뀐 경우
    • deprecated 된 기능 삭제
  • refactor : 코드 리팩토링
    • 변수명, 메소드명 변경
    • 코드 성능 개선 (기능은 동일)
  • fix : 버그 수정
    • 동작하지 않는 기능 수정 (치명적인 버그)
    • 운영에 문제가 일으키는 경우 버그 수정
  • style : 스타일 변경 (포매팅 수정, 들여쓰기 추가, import…)
    • 단순 정렬 등 리뷰어가 더블체크하지 않아도 되는 부분
  • test : 테스트 관련 코드
    • 테스트 코드만 추가/수정된 경우
  • design : 프론트 화면 디자인
    • UI 디자인 변경 시 (기능은 동일)
  • config : CI&CD, build 등 설정 수정
  • chore : 그 외 자잘한 수정
    • 라이브러리 설치

💻 이슈 컨벤션

BE ISSUE 템플릿

---
name: BE 이슈 템플릿
about: BE 이슈 템플릿
title: "[BE] "
labels: "BE"
assignees: ""
---

##  세부 내용

<!-- 이슈의 세부적인 내용을 적어주세요. -->

##  예상 소요 시간

<!-- 예상되는 소요 시간을 적어주세요. -->

FE ISSUE 템플릿

---
name: FE 이슈 템플릿
about: FE 이슈 템플릿
title: "[FE] "
labels: "FE"
assignees: ""
---

##  세부 내용

<!-- 이슈의 세부적인 내용을 적어주세요. -->

##  예상 소요 시간

<!-- 예상되는 소요 시간을 적어주세요. -->

📋 ISSUE 제목

[BE] 로그인 api 만들기

[FE] 로그인 페이지 퍼블리싱


💻 브랜치 컨벤션

커밋 컨벤션/#이슈번호

# 예시
feat/#34 

💻 PR 컨벤션

BE PR 템플릿

제목: [BE] feat: PR 구현 기능 (#이슈번호)

<!--
PR BE 이름 컨벤션
[BE] feat: ~~(#issueNum)
-->

## 📌 관련 이슈

- closed: #issueNum

##  PR 세부 내용

<!-- 수정/추가한 내용을 적어주세요. -->

FE PR 템플릿

<!--
PR FE 이름 컨벤션
[FE] feat: ~~(#issueNum)
-->

## 📌 관련 이슈

- closed: #issueNum

##  PR 세부 내용

<!-- 수정/추가한 내용을 적어주세요. -->

## 🖼️ 스크린샷 (Optional)
Clone this wiki locally