간단한 한 줄 소개 – 프로젝트의 핵심 가치 또는 기능
| 팀원 1 | 팀원 2 | 팀원 3 | 팀원 4 |
|---|---|---|---|
| 사진1 | 사진2 | 사진3 | 사진4 |
| PL | FE | FE | FE |
| [GitHub](깃허브 링크) | [GitHub](깃허브 링크) | [GitHub](깃허브 링크) | [GitHub](깃허브 링크) |
프로젝트의 주요 목적과 사용자가 얻게 될 경험을 설명해주세요.
- 전체 기간:
YYYY.MM.DD - YYYY.MM.DD - 개발 기간:
YYYY.MM.DD - YYYY.MM.DD
For building and running the application you need:
iOS 18.2
Xcode 16.2
Swift 6.0
- Front : SwiftUI
- 버전 및 이슈 관리 : Github, Github Issues
- 협업 툴 : Discord, Notion
| 사진 넣어주세요 | 사진 넣어주세요 |
main- 제품 출시 브랜치develop- 출시를 위해 개발하는 브랜치feat/xx- 기능 단위로 독립적인 개발 환경을 위해 작성refac/xx- 개발된 기능을 리팩토링 하기 위해 작성hotfix/xx- 출시 버전에서 발생한 버그를 수정하는 브랜치chore/xx- 빌드 작업, 패키지 매니저 설정 등design/xx- 디자인 변경bugfix/xx- 디자인 변경
- 파라미터 이름을 기준으로 줄바꿈 한다.
let actionSheet = UIActionSheet(
title: "정말 계정을 삭제하실 건가요?",
delegate: self,
cancelButtonTitle: "취소",
destructiveButtonTitle: "삭제해주세요"
)- if let 구문이 길 경우에 줄바꿈 한다
if let user = self.veryLongFunctionNameWhichReturnsOptionalUser(),
let name = user.veryLongFunctionNameWhichReturnsOptionalName(),
user.gender == .female {
// ...
}- 나중에 추가로 작업해야 할 부분에 대해서는
// TODO: - xxx 주석을 남기도록 한다. - 코드의 섹션을 분리할 때는
// MARK: - xxx 주석을 남기도록 한다. - 함수에 대해 전부 주석을 남기도록 하여 무슨 액션을 하는지 알 수 있도록 한다.
- PR 시, 템플릿이 등장한다. 해당 템플릿에서 작성해야할 부분은 아래와 같다
PR 유형 작성, 어떤 변경 사항이 있었는지 [] 괄호 사이에 x를 입력하여 체크할 수 있도록 한다.작업 내용 작성, 작업 내용에 대해 자세하게 작성을 한다.추후 진행할 작업, PR 이후 작업할 내용에 대해 작성한다.리뷰 포인트, 본인 PR에서 꼭 확인해야 할 부분을 작성한다.
| 아이콘 | 코드 | 설명 | 원문 |
|---|---|---|---|
| 🐛 | bug | 버그 수정 | Fix a bug |
| ✨ | sparkles | 새 기능 | Introduce new features |
| 💄 | lipstick | UI/스타일 파일 추가/수정 | Add or update the UI and style files |
| ♻️ | recycle | 코드 리팩토링 | Refactor code |
| ➕ | heavy_plus_sign | 의존성 추가 | Add a dependency |
| 🔀 | twisted_rightwards_arrows | 브랜치 합병 | Merge branches |
| 💡 | bulb | 주석 추가/수정 | Add or update comments in source code |
| 🔥 | fire | 코드/파일 삭제 | Remove code or files |
| 🚑 | ambulance | 긴급 수정 | Critical hotfix |
| 🎉 | tada | 프로젝트 시작 | Begin a project |
| 🔒 | lock | 보안 이슈 수정 | Fix security issues |
| 🔖 | bookmark | 릴리즈/버전 태그 | Release / Version tags |
| 📝 | memo | 문서 추가/수정 | Add or update documentation |
| 🔧 | wrench | 구성 파일 추가/삭제 | Add or update configuration files. |
| ⚡️ | zap | 성능 개선 | Improve performance |
| 🎨 | art | 코드 구조 개선 | Improve structure / format of the code |
| 📦 | package | 컴파일된 파일 추가/수정 | Add or update compiled files |
| 👽 | alien | 외부 API 변경 반영 | Update code due to external API changes |
| 🚚 | truck | 리소스 이동, 이름 변경 | Move or rename resources |
| 🙈 | see_no_evil | .gitignore 추가/수정 | Add or update a .gitignore file |