💻 코딩 컨벤션

네이밍 컨벤션

• 네이밍 항목 순서는 android-style-guide를 준수한다.
• 단, Layout을 제외한 네이밍은 CamelCase를 사용한다.
  • 예시) android:id="@+id/tvPostNovelTitle"
  • 자세한 정보는 아래 링크를 참고하였다.

• Coding Style은 객체지향 생활 체조 원칙을 준수한다.
  • 자세한 정보는 아래 링크를 참고하였다.

[Java] 객체지향 생활 체조 원칙 9가지 (from 소트웍스 앤솔러지)

🦥 깃 전략 및 컨벤션

브랜치 전략

• GitHub Flow를 사용한다.
  • 수시로 코드가 변하는 앱잼의 특성을 고려하였다.
  • 브랜치 이름은 다음과 같이 언더바를 사용한다.
    • 예시) feature/post_novel
  • 자세한 정보는 아래 링크를 참고하였다.

[GIT] 📈 깃 브랜치 전략 정리 - Github Flow / Git Flow

Commit 컨벤션

• 사용할 커밋 타입은 다음과 같다.
  • 🍯 [FEAT] 새로운 기능 추가
  • ♻️ [REFACTOR] 코드 리팩토링
  • 🔨 [FIX] 버그 수정
  • 🚧 [BUILD] 빌드 업무 수정, 패키지 매니저 수정
• 커밋 메시지 예시는 다음과 같다.
  • 예시) feat: color system 구성
• 커밋 메시지는 한글로 작성하고, 이슈 번호는 별도로 표기하지 않는다.

Issue 컨벤션

• 제목 예시는 다음과 같다.
  • 예시) feat: library view 구현

## ⚔️ Kind (Required)    <!-- 이슈 종류를 선택해주세요 -->
`FEATURE` `BUG`

## 📜 Overview (Required)    <!-- 이슈에 대해 간략하게 설명해주세요 -->

> **✔️ To do**    <!-- 진행할 작업에 대해 적어주세요 -->
> - [ ] color system 구성 _(예시)_

## 📍 Note (Optional) <!-- 특이사항을 적어주세요 -->