Android Team Conventions

Git Workflow Convention

팀 작업에서 브랜치/커밋/이슈/PR 네이밍을 통일하기 위한 컨벤션입니다.

---

브랜치 룰

형식

<type>/#<issueNumber>-<short-description>

• type : 아래 타입 중 하나
• issueNumber : GitHub Issue 번호 (없으면 공백)
• short-description : 짧은 설명 (영문 소문자 권장) + kebab-case
  • 예: home, login-api, map-marker-ui

타입 목록

• init : 초기 세팅
• feat : 기능 구현
• fix : 버그 수정
• hotfix : 긴급 수정(운영 장애 대응)
• refactor : 리팩토링(동작 변경 없이 구조 개선)
• docs : 문서 작업
• chore : 잡무(설정/의존성/스크립트/빌드 등)
• ci : CI/CD 관련

예시

• init/project-setup
• feat/#1-home

---

커밋 룰

형식

<type> #<issueNumber>: <summary>

• type : feat, chore, docs, ci, fix, refactor, hotfix, init
• issueNumber : 연결된 이슈 번호(없으면 공백)
• summary : 한 줄 요약(명령문 형태 권장)

예시

• [init]: setup project structure
• [feat] #1: add home screen UI

제목이 길어지면 아래처럼 본문 추가 가능
1행: 제목(위 규칙 유지)
빈 줄
상세 설명/변경 이유/참고 링크

---

이슈 컨벤션

형식

[Type] <title>

• Type은 아래 중 하나 (PascalCase)
  • Feat, Fix, Hotfix, Refactor, Docs, Chore, CI, Init

예시

• [Feat] 홈 화면 구현
• [Refactor] 지도 마커 렌더링 구조 개선
• [Docs] 컨벤션 문서 추가
• [Chore] 의존성 업데이트
• [CI] PR 빌드 워크플로 추가
• [Init] 프로젝트 초기 세팅

---

PR 컨벤션

1) PR 제목 형식

[Type] #<issueNumber> <title>

• Type (PascalCase): Feat, Fix, Hotfix, Refactor, Docs, Chore, CI, Init
• issueNumber: 연결된 이슈 번호 (없으면 공백)
• title: PR 요약

PR 제목 예시

• [Feat] #11 홈 화면 UI 추가
• [Refactor] #19 마커 렌더러 모듈 분리