🤖 AN 개발 컨벤션

🔈 Coding Convention

kotlin Coding Convention 을 따른다.

팀 코딩 컨벤션 노션를 참고해주세요!

📂 Package

1. 패키지 네임은 반드시 소문자로 작성한다.

2. 패키지는 크게 data, presentation, remote, local 로 분리한다.

3. UiState, UiEvent 와 관련된 코드는 파일 분리하되, ViewModel 과 동일한 패키지에 넣는다.

4. BindingAdapter

• 공통으로 사용할 수 있는 경우에는 Common
• CustomView 에서 사용하는 경우에는 해당 파일 내의 companion object에 위치하도록 한다.
• 특정 화면에서만 사용하는 경우에는 해당 화면 package 안에서 만들어 사용한다.

예시 자료

📂 Naming

Resource 파일 및 ID 네이밍은 기본적으로 [where]_[what] 을 명시한다.

Event를 처리 하는 인터페이스는 XXXHandler 로 통일한다

Function

반환값이 있는 함수는 빌더 패턴 네이밍 형식을 따른다.

fun pocketBall(): PocketBall { .. }

// 만약 pocketBall 을 어떠한 가공을 해서 리턴받아야 하는 경우
fun availablePocketBall(): PorkcetBall { .. }

Layer Model

// entity
data class PocketMonEntity

// dto
data class PocketMonResponse
data class PocketMonRequest

// data - model (postfix X)
data class PocketMon

// UiModel
data class PocketMonUiModel

📂 각 Layer Model 의 의존성 방향

UiModel -> Data -> Dto으로 단방향으로 한다. 이러한 의존성 방향은 구글 권장 아키텍처에 가깝다. (클린 아키텍처가 아님)

// -------------------------------------
package ~~~.presentation.model

data class PokemonUiModel(
    ...
)

fun Pokemon.toUi(): Pokemon = ...

// -------------------------------------
package ~~~.data.model

data class Pokemon(
    ...
)

fun PokemonResponse.toData(): Pokemon = ...

// -------------------------------------
package ~~~.dto.respoonse

data class PokemonResponse(
    ...
)
// -------------------------------------

---

🔈 Github Convention

📌 Commit

feat : 새로운 기능 추가 feat: 어쩌구 저쩌구 한다

ui : ui 관련 작업

fix : 잘못된 부분 수정

chore : 버전 코드 수정, 패키지 구조 변경, 파일 이동, 가독성이나 변수명, reformat 등

refactor : 내부 로직은 변경 하지 않고 기존의 코드를 개선하는 리팩토링 시

docs : README나 WIKI 등의 문서 개정

build : gradle 같은거 관련된거 추가할 때

📌 Issue

[vesion/type] 작업 내용

ex)
[1.0.0/AN-UI] home XML 구현 / 규칙 뷰 구현

템플릿

• Assignees : 자기 자신
• Labels : 작업 유형 (e. an_feat)
• Projects : 작업 관련 보드 (e. 1차 배포)
• MileStone : 작업 관련 마일스톤 (e. 포켓로그 1차 배포)

📌 PR

[vesion/type] 작업 내용

ex)
[1.0.0/AN-UI] home XML 구현 / 규칙 뷰 구현

템플릿

• Reviewers : 안드로이드 팀원 모두 선택
• Labels : PR, 작업 타입
• Projects : 작업 관련 보드 (e. 1차 배포)
• MileStone : 작업 관련 마일스톤 (e. 포켓로그 1차 배포)
• Development : 해당 이슈 연결 ← 머지시 자동으로 해당 이슈가 닫히게 해줌

### 작업 개요

### 작업 설명

- 상세히
- 보는 사람 이해 쉽게

### 작업 사진 (선택)

- 있으면 보기 편할듯

### 다음 태스크

📌 Projects

To do

• 이슈를 추가할 때 프로젝트를 선택하고 생성하면 자동으로 To-do 안에 들어간다

In Progress

• PR을 만들면 자동으로 추가된다

Done

• 이슈, PR이 닫히면 자동으로 추가된다.