Skip to content

우리 팀 컨벤션

n-ryu edited this page Dec 18, 2022 · 4 revisions

커밋 컨벤션

  • 타입은 영문 소문자로 적고, 메시지는 한글로 작성한다.
  • 제목 외 본문은 각자 판단에 따라 필요시 자유롭게 작성한다.
  • 본문은 어떻게 보다 무엇을, 를 설명한다.
  • 타입은 아래와 같은 사용한다.
    fix: 버그, 오류 해결
    feat: 새로운 기능 구현
    refactor: 코드개선하는 리팩토링
    env: 기타 환경 설정
    test: 테스트 코드 추가
    chore: 그 외의 일
    doc: README나 WIKI 등 내용 추가 및 변경
    style: 레이아웃 등 스타일
    merge: 브랜치 병합
    
    ex) feat: 로그인 UI 구현 - close #1
    

이슈 템플릿

GitHub Issue Form을 활용하여 4가지 Issue Form을 구분하여 사용

피처 템플릿

  • 담당 개발자 본인이 피처 개발 이전에 작성하는 피처 이슈 템플릿
  • Backlog 작성 후에 이슈를 작성한다.
  • 세부 피처는 마이크로 피처 템플릿으로 작성하고 tasklist 형태로 링크를 한다.
  • 해당 피처를 작업할 때에는 Issue에서 branch 생성 기능을 활용해 branch를 만들고 작업한다.

마이크로 피처 템플릿

  • 담당 개발자 본인이 피처 개발 시에 세부 피처를 명시하기 위해 작성하는 마이크로 피처 이슈 템플릿
  • 세부 피처를 미리 작성하고, commit에 이슈 넘버와 resolvefix와 같은 키워드를 함께 적어 커밋으로 이슈를 닫는다.
  • 세부 피처의 작업 규모가 크다고 예상된다면, Issue에서 branch 생성 기능으로 branch를 만들고, 피처 branch에 스쿼시 머지한다.

피처 요청 템플릿

  • 다른 개발자에게 피처를 요청하고 싶을 때 사용하는 템플릿
  • 서로의 개발 영역간 인터페이스, 코드 리뷰 중 나온 의견 등 본인이 아닌 다른 개발자에게 피처를 요청할 때에 사용한다.
  • 요청이다보니, 반드시 제출 전에 asignee를 지정하고 이슈를 생성하도록 한다.

버그 리포트

  • 현재 있는 버그를 리포트하는 템플릿
  • 버그를 수정할 때에도 Issue에서 branch 생성 기능으로 branch를 만들고 머지한다.
  • 단, PR 및 merge commit에 fix: 태그로 버그 수정임을 명시하도록 한다.

PR 템플릿

## 개요

## 세부 내용

## 공유
- 고민과 질문
- 해결 과정의 기록은 정리해서 위키에 수록 후 링크 달기 

## relavant issue number
- 관련된 이슈 넘버가 있으면 이곳에 기입해주세요

💊 비타500

📌 프로젝트

🐾 개발 일지

🥑 그룹활동

🌴 멘토링
🥕 데일리 스크럼
🍒 데일리 개인 회고
🐥 주간 회고
👯 발표 자료
Clone this wiki locally