Skip to content

🤙Convention

Seungmin edited this page Nov 8, 2022 · 3 revisions

Commit Convention

💡 깃모지 커밋메세지
ex) ✨ 로컬 캐싱기능 추가

커밋 종류 아이콘 코드 설명 원문
Feat 새 기능 Introduce new features.
Refactor ♻️ ♻️ 코드 리팩토링 Refactor code.
Fix 🐛 🐛 버그 수정 Fix a bug.
Rename 🚚 🚚 리소스 이동, 이름 변경 Move or rename resources (e.g: files paths routes).
Remove 🔥 🔥 코드/파일 삭제 Remove code or files.
Layout 💄 💄 UI/스타일 파일 추가/수정 Add or update the UI and style files.
Docs 📝 📝 문서 추가/수정 Add or update documentation.
Test 테스트 추가/수정 Add or update tests.
Poop 💩 💩 똥 싼 코드 Write bad code that needs to be improved.
Chore 🔧 🔧 위 사항들을 제외한 모든 경우 In all cases except for the above.
  • 커밋 메시지는 한글로
  • 커밋 전 변경 사항 꼭 확인
  • 리베이스 ❌

Kotlin Convention

💡 기본적인 코틀린 컨벤션은 안드로이드 공식문서 를 따름.

  • 필요없는 주석 커밋 전 제거
  • ! 대신 .not() 사용
  • !! 사용 ❌
  • Ktlint 플러그인 포맷팅

Naming Convention

Branch Strategy

githubflow

  • main: 우리의 main 브랜치, upstream에 PR을 날릴 수 있는 branch
  • feature/기능 이름: 작은 기능 하나를 개발하는 branch
  • refactor/화면(기능): 기능 개발 이후 리팩토링을 수행하는 branch

Android Convention

💡 커밋 전 Code Formatting!! (Ctrl + Alt + L)
Warning 모두 해결하기
TestCode 작성

  • Android Studio 버전 : Dolphin
  • wrap column limit : 100 (기본값)
  • minSDK : 23
    • 런타임 시점에 권한 요청을 하기 위하여 23으로 선택
  • targetSDK : 33
    • 최신 버전이기 때문에 선택
  • Single Import
    • 불필요한 import를 피하기 위함
  • Api key local properties로 관리
    • key가 노출되는 것을 방지하기 위함
Clone this wiki locally