https://github.com/Team-Smeme/Smeme-iOS
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/d273f82c-3a4a-48bb-b6d7-64c07b831d96/notice_(2).png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/d273f82c-3a4a-48bb-b6d7-64c07b831d96/notice_(2).png" width="40px" /> README에 들어가야 할 내용을 다음과 같습니다.
6가지의 내용은 반드시 포함시켜주세요.
이외 다른 요소들은 팀 내에서 자유롭게 기재해주시면 됩니다.
</aside>
간단한 프로젝트 설명
프로젝트에 대해 2~3줄 이내로 간략하게 소개해주세요.
참여 구성원
팀원 소개에 대한 내용 및 형식은 자유입니다.
사용할 라이브러리
어떤 라이브러리를 사용할 지 적어주시고, 선택 및 사용 이유에 대해서 간략하게 적어주세요.
Coding Convention
노션에 정리된 내용을 첨부해도 좋고 README에 직접 기입해도 무방합니다.
팀 내에서 어떤 방식을 통해 Convention을 만들지 정해주세요. SwiftLint 같은 라이브러리를 활용해서 Convention을 지켜도 좋고, 팀 내에서 자율적으로 규칙을 정해주시면 됩니다.
아래의 가이드처럼 너무 세세하게 정할 필요는 없고, 여러분들이 꼭 필요할 것 같은 Convention만 정의해주시면 될 것 같아요.
Git Flow 전략
Git 협업 방식을 정리해주세요.
팀 내에서 Git Branch를 어떤 방식으로 설정하여 협업을 할지 기재해주세요. 간단하게 기재하셔도 좋습니다.
프로젝트 폴더링 Convention
팀 내에서 어떤 폴더링 컨벤션을 사용할지 정해주세요. 폴더링에는 절대로 정답이 없으며, 팀 내에서 효율적인 방식을 정해주시면 됩니다. 이미지 또는 Markdown 등의 형식으로 정리해주시면 됩니다.단, 폴더링을 적용한 Xcode 프로젝트 파일이 GitHub에 올라가 있어야 한다는 점 기억해주세요.
<aside> 💡 8차 세미나에서 프로젝트 설계에 관한 부분을 간략하게 다뤘습니다.
세미나에서 진행한 방식이 아니더라도 팀원들과 함께 고민해보시고 이미지로 노션에 제출해주세요!
너무 부담갖지마세요!
</aside>
프로젝트 설계에 들어가야 하는 항목은 다음과 같습니다.
ViewController에 어떤 네트워크 코드가 들어갈지?
현재 기능과 와이어 프레임에 대해 논의를 진행하고 계시죠?!
그에 따라 와이어 프레임이 하나씩 나오고 있을 것 같습니당 !
해당 뷰에 어떤 네트워크 코드를 작성해야할지에 대해 간략하게 적어주세요!
팀원들과 함께 논의하고 간략하게 그려주세요! (Figma, 굿노트 등등)
역할과 책임에 따라 네모박스 색 나누기
클래스, 프로토콜 등으로 색을 구분할 수 있고,
ViewController, ViewModel에 따라 색을 구분할 수도 있을 것 같아요!
팀원들과 논의하고 제출 내용에 포함해주세요!
.png){kind=link}