Git Convention

이 페이지는 Notion(AIOT-Team3-InsightON)에서 정리해 옮긴 내용입니다. 최신 원본은 Notion에서 확인하세요. (일회성 정리 — 자동 동기화 아님)

Git Convention

브랜치 전략 (Git-Flow 변형)

• main: 최종 배포 브랜치 (안정)
• develop: 개발 메인 브랜치 (다음 배포 버전)
• feature/[기능명]: 기능 개발 브랜치 (예: feature/cart)
  • develop 브랜치에서 분기합니다.
  • 개발 완료 시 develop 브랜치로 Pull Request (PR)
• fix/[이슈명]: 긴급 버그 수정 브랜치
• refactor/[이슈명]: 리팩토링 브랜치

커밋 메시지 구조

커밋 메시지는 크게 제목, 본문, 꼬릿말 세 가지 파트로 나누고, 각 파트는 빈 줄을 두어서 구분합니다.

// Header, Body, Footer는 빈 행으로 구분한다.
타입(스코프, type): 주제(제목, subject) // Header
<빈 행>
본문 // Body
<빈 행>
바닥글 // Footer

• type: 어떤 의도로 커밋했는지를 type에 명시합니다.
• subject: 최대 50글자가 넘지 않도록 하고 마침표는 찍지 않습니다. 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기합니다.
• body: 긴 설명이 필요한 경우에 작성합니다. 어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성합니다. 최대 75자를 넘기지 않도록 합니다.
• footer: issue tracker ID를 명시하고 싶은 경우에 작성합니다.

커밋 메시지 규칙

1. 제목과 본문을 빈 행으로 구분한다. (강제사항 아님 — 한 줄 요약이 더 효율적일 수도 있음)
2. 제목은 50글자 이내로 제한한다. (영문 기준)
3. 제목의 첫 글자는 대문자로 작성한다.
4. 제목 끝에는 마침표를 넣지 않는다.
5. 제목은 명령문으로 사용하며, 과거형을 사용하지 않는다.
6. 본문의 각 행은 72글자 내로 제한한다. (72글자마다 줄바꿈)
7. 본문은 어떻게 보다는 무엇과 왜를 설명한다.

커밋 Type

형식: [Type]: [Subject] (예: Feat: 장바구니 추가 기능 구현)

커밋 유형	의미
Feat	새로운 기능 추가
Design	CSS 등 사용자 UI 디자인 변경
Docs	문서 수정
Style	코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우
!BREAKING CHANGE	커다란 API 변경의 경우
Comment	필요한 주석 추가 및 변경
Rename	파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우
Refactor	코드 리팩토링
Remove	파일을 삭제하는 작업만 수행한 경우
Test	테스트 코드, 리팩토링 테스트 코드 추가
Chore	패키지 매니저 수정, 그 외 기타 수정 (예: .gitignore)
!HOTFIX	급하게 치명적인 버그를 고쳐야 하는 경우
Fix	버그 수정
Ci	CI 설정 파일 수정
Perf	성능 개선

커밋 메시지로 GitHub 이슈 자동 종료시키기

영문 커밋 메시지에 아래 예약어 + 이슈번호를 쓰면 해당 브랜치가 default branch에 머지될 때 이슈가 자동으로 닫힙니다.

키워드 #이슈번호

닫힘으로 인식되는 키워드: close closes closed fix fixes fixed resolve resolves resolved

• close 계열은 일반 개발 이슈
• fix 계열은 버그 픽스/핫픽스 이슈
• resolve 계열은 문의/요청 대응 이슈

예시:

Close #31 - refactoring wrap-up

* This is wrap-up of refactoring main code.
* main.c
  * removed old comments
  * fixed rest indentations
  * method extraction at line no. 35

여러 개를 한 번에 닫을 수도 있습니다: This closes #128, closes #129, and fixes #78.

기본 브랜치(예: master)에 커밋을 푸시하면 즉시 닫히고, develop에 푸시했다면 develop -> master 머지 시점에 닫힙니다.

Issue 등록 요령

Label 종류

• Setting: 개발 환경 세팅
• Feature: 기능 개발
• Deploy: 배포 관련
• Html&css: 마크업, 스타일링
• BugFix: 버그 관련
• CrossBrowsing: 브라우저 호환성
• Docs: 문서 작성 및 수정(readme.md) 등
• API: 서버 API 통신
• Refactor: 코드 리팩토링
• Question: 질문 또는 정보 요청
• Accessibility: 웹 접근성 관련
• Test: test 관련 이슈

작성하고 싶은 이슈 종류를 선택 후, 양식(템플릿)에 작성해주시면 됩니다.

Pull Request 작성 요령

PR 양식에 맞추어 내용 작성 후 PR을 날려주세요.

PR에서 이슈 닫는 키워드 구문

연결된 문제	구문	예시
동일한 리포지토리의 문제	KEYWORD #ISSUE-NUMBER	Closes #10
다른 리포지토리의 문제	KEYWORD OWNER/REPOSITORY#ISSUE-NUMBER	Fixes octo-org/octo-repo#100
여러 문제	각 문제에 대해 전체 구문 사용	Resolves #10, resolves #123, resolves octo-org/octo-repo#100

키워드 뒤에는 콜론이나 대문자로 표시될 수 있습니다. 예: Closes: #10, CLOSES #10, CLOSES: #10.

수동으로 연결된 PR만 수동으로 연결을 해제할 수 있습니다. 키워드로 연결한 문제를 연결 해제하려면 PR 설명을 편집해 키워드를 제거해야 합니다.

커밋 메시지에서 닫는 키워드를 사용할 수도 있습니다. 다만 커밋이 포함된 PR이 default 브랜치에 머지될 때 이슈는 닫히지만, 그 PR 자체가 "연결된 PR"로 표시되지는 않습니다.

---

원본에 있던 스크린샷(라벨 화면, 이슈 템플릿 선택 화면, PR 템플릿 렌더링 예시)은 임시 서명 URL이라 여기 옮기지 못했습니다. 필요하면 Notion 원본에서 확인해주세요.

참고 (우테코 스타일)

Java 코드 스타일은 Code Convention 페이지의 Google Java Style Guide 요약 및 우테코 포매터 설정을 따릅니다.