Skip to content

[UMC 6th 웹 프로젝트 '로컬마크'] Server

Notifications You must be signed in to change notification settings

local-mark/backend

Repository files navigation

LOCAL-MARK-BE

Branch Rules

Main Branch

  • 브랜치 이름 : Main
  • 최종 배포가 가능한 상태만을 관리하는 브랜치입니다.

Feature Branch

  • 브랜치 이름 : feature/<기능명>/#<이슈번호>
  • 브랜치 이름 예시 : feature/login/#1
  • 기능 개발, 오류 수정 등에 사용되는 브랜치입니다.

Git Commit Message Convention

Commit Message 구조

  • 헤더는 필수이며, 범위(scope), 본문(body), 바닥글(footer)은 선택 사항입니다.
<type>(<scope>): <subject>          -- 헤더
<BLANK LINE>
<body>                              -- 본문
<BLANK LINE>
<footer>                            -- 바닥글

헤더

  • type, subject로 구성되어 있습니다.
Commit Type
  • type은 해당 커밋의 성격을 나타내며 아래 중 하나여야 한다.
    커밋 유형 의미
    Feat 새로운 기능 추가
    Fix 버그 수정
    Docs 문서 수정
    Style 코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우
    Refactor 코드 리팩토링
    Test 테스트 코드, 리팩토링 테스트 코드 추가
    Chore 그 외 기타 수정 ex) .gitignore
    Comment 필요한 주석 추가 및 변경

Subject 규칙

  • 제목은 영문 기준 50자 이내로 제한
  • 첫 글자는 대문자로 작성, 끝에는 .(마침표) 금지
  • 명령문으로 작성, 과거형 금지
  • 이슈 넘버가 있을 경우 기입

본문(body) 규칙

  • 본문은 선택사항이며, 최대한 상세히 작성
  • 각 행은 72자 이내로 작성
  • 길어질 경우 개행을 통해 입력
  • 어떻게 보다는 무엇과 왜를 설명
  • 글머리 기호도 사용 가능. 하이픈(-), 별표(*)

꼬리말(footer) 규칙

  • 꼬리말은 선택사항이며, 이슈 트래킹을 위해서 사용된다.(commit 후 이슈 종료 가능)
  • "유형: #이슈 번호" 형식으로 작성
  • 여러 개의 이슈 번호는 쉼표(,)로 구분

관련 내용 - Github 이슈와 커밋 메시지 연결

Commit message 예시

Feat: 카카오 로그인 기능 추가(#1)

소셜 로그인 기능 추가를 위해 카카오 로그인 기능을 추가함

Close: #1, #12

About

[UMC 6th 웹 프로젝트 '로컬마크'] Server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •