34st NOW SOPT APP JAM
프로젝트 기간 : 2024.06.15 ~
“다양한 목소리를 통해 더 나은 학생 사회, 더 나은 대학 생활을 만들기 위해서”
학생회와 학생들의 목소리로 함께 만들어가는 대학 생활 필수 앱, 유니보이스 입니다.⏰
| 김언지 | 박유진 | 이가을 | 임하늘 |
| [👑 Team Leader] 메인 홈 공지사항 등록화면 자동로그인 |
[🤖 Team Member] 공지사항 세부화면 타임 피커 |
[🤖 Team Member] 로그인 퀵스캔 저장 홈 |
[🤖 Team Member] 회원가입 마이페이지 |
| 스플래시 | 초기 | 로그인 |
| 회원가입 | 회원가입_개인정보입력 | 회원가입_학생증 인증 |
| 회원가입_계정 생성 | 회원가입_약관동의 | 회원가입_학생증 확인 |
| 메인 홈 | 퀵스캔 | 공지사항 세부화면 |
| 저장 홈 | 공지사항 등록화면 | 마이페이지 |
| Title | Content |
|---|---|
| Architecture | Clean Architecture, MVVM |
| Design Pattern | Repository Pattern, Adapter Pattern, Observer Pattern |
| Jetpack Components | AAC Bottom Navigation, ViewPager2, Preference Datastore, Lifecycle, ViewModel, DataBindng |
| Dependency Injection | Hilt |
| Network | Retrofit, OkHttp, Multipart |
| Asynchronous Processing | Coroutine(+ Flow) |
| Third Party Library | Coil, Timber, kotlinSerialization, CircleIndicator, CircleImageView, Lottie |
| CI | Github Action(KtLint, Compile Check) |
| Other Tools | Slack, Notion, Figma, Postman |
📦com.univoice
├─📂app
│ ├─📂di
│ ├─📂interceptor
├─📂core_ui
│ ├─📂base
│ ├─📂component
│ ├─📂theme
│ ├─📂util
│ ├─📂view
├─📂data
│ ├─📂datasource
│ ├─📂dto
│ │ └─📂request
│ │ └─📂response
│ ├─📂mapper
│ ├─📂repositoryimpl
├─📂data_local
├─📂data_remote
│ ├─📂api
│ ├─📂datasourceimpl
├─📂domain
│ ├─📂entity
│ ├─📂repository
├─📂feature
│ ├─📂entry
│ ├─📂home
│ ├─📂login
│ ├─📂noticeDetail
│ ├─📂noticePost
│ ├─📂quickscan
│ ├─📂setting
│ ├─📂signup
│ ├─📂storage
└─📂util
- 사용할 커밋 타입은 다음과 같다.
- ⭐ [FEAT] : 새로운 기능 구현
- ✅ [MOD] : 코드 수정 및 내부 파일 수정
- ➕ [ADD] : 부수적인 코드 추가 및 라이브러리 추가, 새로운 파일 생성
- 🛠️ [CHORE] : 버전 코드 수정, 패키지 구조 [C변경, 타입 및 변수명 변경 등의 작은 변경 등 진짜 별 거 아닌]
- 🚫 [DEL] : 쓸모없는 코드나 파일 삭제
- 💟 [UI] : UI 작업 - xml
- 🔨 [FIX]: 버그 수정
- 🚑️ [HOTFIX] : issue나 QA에서 문의된 급한 버그 및 오류 해결
- 🚚 [MOVE] : 프로젝트 내 파일이나 코드의 이동 (패키지 위치 이동)
- ⏪️ [RENAME] : 파일 이름 변경
- ♻️ [REFACTOR]: 코드 리팩토링
- 📃[DOCS] : README나 WIKI 등의 문서 개정
- 커밋 메시지 예시는 다음과 같다.
- 예시) `#이슈번호 [FEAT] : 마이페이지 API 연결`
- 제목
[Feat] : color system 구성 (예시)
## 📌𝗧𝗮𝘀𝗸
- [ ]
- [ ]
## 💡𝗥𝗲𝗳𝗲𝗿𝗲𝗻𝗰𝗲
- 제목
[Feature/#이슈번호] : color system 구성 (예시)
## ✅ 𝗖𝗵𝗲𝗰𝗸-𝗟𝗶𝘀𝘁
- merge할 브랜치의 위치를 확인해 주세요.(main❌/develop⭕)
- 리뷰가 필요한 경우 리뷰어를 지정해 주세요.
- 리뷰는 PR이 올라오면 최대한 빠르게 진행합니다.
- P1 단계의 리뷰는 빠르게 확인 후 반영합니다.
- Approve된 PR은 assigner가 머지하고, 수정 요청이 온 경우 수정 후 다시 push를 합니다.
## 📌 𝗜𝘀𝘀𝘂𝗲𝘀
- closed #이슈번호
## 📎 𝗪𝗼𝗿𝗸 𝗗𝗲𝘀𝗰𝗿𝗶𝗽𝘁𝗶𝗼𝗻
-
-
## 📷 𝗦𝗰𝗿𝗲𝗲𝗻𝘀𝗵𝗼𝘁
## 💬 𝗧𝗼 𝗥𝗲𝘃𝗶𝗲𝘄𝗲𝗿𝘀
## 📌 𝗗𝗲𝘀𝗰𝗿𝗶𝗽𝘁𝗶𝗼𝗻
코드 리뷰 룰은 뱅크샐러드의 Pn 룰을 차용하되, 앱잼 특성에 맞게 사용합니다.
**P1: 꼭 반영해주세요 (Request changes)**
⏩ 앱잼 기간 내에 반영
ex) P1: ~~~
**P2: 반영해도 좋고 넘어가도 좋습니다 (Approve)**
⏩ 후 순위, 앱잼 기간 후에 반영 (만약 맡은 역할이 모두 끝날 시 반영해도 됨.)
ex) P2: ~~~
**P3: 그 외 질문 등의 소통 (Approve)**
⏩ 질문엔 답변, 그 외는 이모지 답변
## 💡𝗥𝗲𝗳𝗲𝗿𝗲𝗻𝗰𝗲
https://blog.banksalad.com/tech/banksalad-code-review-culture/