Skip to content

Convention Guide

박종윤 edited this page Jul 26, 2023 · 5 revisions

Commit 규칙

git commit -m "feat: commit messages"

  • feat : 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정
  • fix : 기능에 대한 버그 수정
  • build : 빌드 관련 수정
  • chore : 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
  • docs : 문서(주석) 수정
  • style : 코드 스타일, 포맷팅에 대한 수정
  • refactor : 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경
  • release : 버전 릴리즈
  • merge : 병합

PR 규칙

  • PR 템플릿에 따라 해결한 이슈 칸에 close #이슈번호를 작성한다.
  • ex) 이슈 번호가 8번일 시 close #8
  • 구현한 기능에 대한 요약, 자세한 설명, 필요 시 스크린샷을 첨부한다.
  • 체크리스트를 확인하고 PR 요청을 보낸다.
  • 다른 개발자가 PR 내용을 확인하고 문제 없을 시 merge한다.

Issue 규칙

  • Issue 템플릿에 따라 목적, 작업 상세 내용, (필요 시)참고 사항을 적어준다.
  • 이슈를 해결할 사람이 정해져 있는 경우 assignee를 해당 인원으로 설정한다.(보통 자신)
  • 목적에 맞는 Label을 설정한다.
  • Projects에서 Buserve Server를 선택한다.

Branch 생성 규칙

image

main

  • 제품으로 출시될 수 있는 브랜치

develop

  • 개발 중인 기능들이 모이는 브랜치
  • main 브랜치에서 배포하기 전까지 develop 브랜치 기준으로 배포할 예정

feature

  • 각 기능을 개발하는 브랜치
  • develop 브랜치로부터 "feature/{issue-number}-{기능 요약}" 브랜치를 만들어 기능을 개발한다.
  • ex) 5번 이슈의 예약 기능을 만들 시 "feature/5-reservation"
  • 기능 개발이 끝나면 develop branch로 PR을 보낸다.

Clone this wiki locally