README.md

Instagram Re-design Project (ANDROID)

CONTRIBUTORS

김선환 (@SeonHwan-Kim)	박민주 (@minju1459)	전채연 (@b1urrrr)
Main New Post	DM	Story

TECH STACK

• App Architecture
• Hilt
• Coroutine
• Data Binding
• Coil & Glide

COMMIT CONVENTION

• ✨ [FEAT] : 새로운 기능 구현
• ✅ [MOD] : 코드 수정 및 내부 파일 수정
• ➕ [ADD] : 부수적인 코드 추가 및 라이브러리 추가, 새로운 파일 생성
• 🎀 [CHORE] : 버전 코드 수정, 패키지 구조 변경, 타입 및 변수명 변경 등의 작은 작업
• ⚰️ [DEL] : 쓸모없는 코드나 파일 삭제
• 💄 [UI] : UI 작업
• 🔨 [FIX] : 버그 및 오류 해결
• 🚑️ [HOTFIX] : issue나 QA에서 문의된 급한 버그 및 오류 해결
• 🔀 [MERGE] : 다른 브랜치와의 MERGE
• 🚚 [MOVE] : 프로젝트 내 파일이나 코드의 이동
• ⏪️ [RENAME] : 파일 이름 변경
• ♻️ [REFACTOR] : 전면 수정
• 📝 [DOCS] : README나 WIKI 등의 문서 개정

BRANCH CONVENTION

브랜치유형/#이슈번호-작업내용

ISSUE CONVENTION

[작업유형] 뷰이름 / 작업내용

PR CONVENTION

[작업유형/#이슈번호] 뷰이름 / 작업내용

CODING CONVENTION

• 기본적인 ktlint 문법 준수

PACKAGE CONVENTION

📦java.com.keyneez 
 ┣ 📂data
 ┃ ┣ 📂model
 ┃ ┃ ┣ 📂response
 ┃ ┃ ┣ 📂request
 ┃ ┣ 📂repository
 ┣ ┣ 📂service
 ┃ ┣ 📂source
 ┣ 📁di
 ┣ 📂domain
 ┃ ┣ 📂entity
 ┃ ┣ 📂repository
 ┣ 📂ui
 ┃ ┃ ┣ 📂dm
 ┃ ┃ ┣ 📂home
 ┃ ┃ ┣ 📂main
 ┃ ┃ ┣ 📂newpost
 ┃ ┃ ┣ 📂story
 ┣ 📁util
   ┣ 📂binding
   ┣ 📂extension

▶ CHECK THE DEMO VIDEO!