(MC2) 협업 ? 시작해볼게 !

서론

오랜만에 씁니다.
그렇게 귀찮았던 블로그 회고를 쓰게 하다니 !
그만큼 오늘 세션은 저에게 엄청난 설렘과 의미? 를 가져다 주었습니다 !

그동안 회고록을 작성하지 않았던 건 아닙니다.
팀에서 공동 회고록을 작성하고 있는데, 언젠간 ? 아마도 (바라건대) 머지 않아 여기다가 정리해서 올릴 생각입니다.

그래서 오늘 무엇을 했냐면 ?

개발 설계 문서
팀내 코드 협업 규칙

을 만들었습니다 !
이걸 쓰고 있는 지금도 두근두근 하군뇨 !

본론

📝 개발 설계 문서

사실 이건 아직 작성 중입니다.

지금까지 정해진 건 이번 MC2 프로젝트는 MVVM 패턴을 따른다는 것 ! 입니다

일단 넘어가겠습니다.

💻 코드 협업 규칙

0404팀은 다음과 같은 사이클을 통해 협업합니다.

다음은 토의를 통해 정한 팀내 협업 규칙입니다.

1. 이슈 생성

💡
사전에 협의 하에 분할된 기능과 분업을 받은 사람이 깃허브에서 Issue 를 만듭니다.
Issue의 목적은 작업의 시작 알림 , 본인의 작업 진도율 확인입니다.

이슈 만들기

Issue 에 포함될 내용은 구현할 기능의 한줄 요약, 구현할 내용, 피그마에서 관련된 뷰 또는 다이어그램에서 기능 관계 캡쳐, 예상 마감 시간 등을 줄 글로 작성합니다.

이슈 닫기

이슈에 생성된 #Num은 커밋 메시지에 포함하고 깃에서 해당 기능이 push 한 후 pull request를 생성합니다.
생성된 pull request에서 이슈를 닫습니다.

2. Git 코드 Pull & Push

💡
깃허브에서는 기능 별로 브랜치를 파 pull 과 push 를 합니다.
브랜치는 rebase 방식으로 합칩니다.
브랜치명 예시 feature/uploadImage, GUI/uploadImage

rebase 방식에 대해선 더 공부해봐야 될 것 같습니다.

# 새로운 브랜치를 파서 작업을 시작합니다. 
git branch "브랜치명"
# 브랜치를 바꿔줍니다.
git checkout "브랜치명" 
# main branch에서 rebase 로 최신 코드를 받아옵니다.
git pull --rebase origin main

# conflict 를 해결하고 코드를 이어 작성합니다. 작성이 완료되면 원격저장소에 추가합니다. 
git add .
git commit -m "커밋메시지"
# 새로 작성한 브랜치를 원격저장소에 커밋합니다.
git push origin "브랜치명"
# 이후 깃헙 페이지에서 pull request 를 보내 Main 에 병합하는 과정을 거칩니다.

커밋 메시지 컨벤션

💡
커밋 메시지는 아래의 태그를 참고해 업로드합니다.
커밋 메시지는 깃헙 페이지에 업로드 될 때 표시되는 메시지입니다.

# example git commit message
git commit -m "[FEAT][#12] 유저간 연결 기능 개발"

커밋 메시지 태그

FEAT: 새로운 기능 추가, 삭제
FIX: 버그, 오타 수정
REFACTOR: 코드 리팩토링
DOCS: 코드 외 문서 수정
STYLE: 코드 포맷팅, 에셋 추가
TEST: 테스트 코드
CHORE: SPM, gitignore, 빌드 관련 등

3. Pull Request

💡
Pull Request는 main 브랜치의 코드를 온전히 보존하면서 구현이 완료된 코드를 main 브랜치에 병합하기 위해 필요합니다.

다음은 0404팀의 Pull Request 규칙 입니다

자신이 작성한 기능과 연관된 코드가 있을 경우 그 코드 작성자에게 pull request를 할 때 관련된 Reviewer 를 지정합니다.
연관된 기능이 없을 경우 카카오톡 단톡방에 pull request 를 알리고 리뷰어를 한 명 이상 지정해 다른 개발자에게 승인받아 main 으로 병합합니다.

Pull Request 날리기