📓 [회의록] 그라운드 룰 선정

2024.10.28.(월)

📝 회의 주제

• 팀 문화 선정
• Convention 설정(Commit, Issue, PR..)
• 문서화 규칙

🏁 회의 내용

📋 팀 문화

팀이 같은 목표로 프로젝트를 진행하면서 서로 성장을 하기 위해서 팀 문화를 선정하기로 하였다.

우리는 기술적으로 성장하고 모든 액션에 근거를 만들기 위하여 다음과 같은 의견들을 제시하였다.

• 모르거나, 잘 안되는 부분은 즉각적으로 공유해서 함께 해답 찾기
• 모르는 것이 있다면 이해될 때까지 질문하고 답변하는 사람은 이해가 될 때까지 착실하게 답변하기
• 개인의 지식이 팀의 지식이 될 수 있도록 하자
• 의견 충돌이 발생하면 10분 토론을 통하여 결정하자

이를 통하여 서로가 학습하고 작성한 기술, 코드에 대하여 모두 이해하고 서로 더 나은 근거를 제시해서 설득이 가능하다면 기술적 근거가 더 탄탄해질 것이라고 생각하였다.

Convention 설정

Commit Message Convention

commit의 형태를 통일하여 어떤 작업을 진행하였는지 더 쉽게 추적하고 이해하기 위하여 결정하였다. Header는 다음과 같이 정하였다.

• UI -> 화면 개발 (View, compose)
• Fix -> 버그 픽스
• Refactor -> 리팩토링 진행
• Docs -> 문서 수정, 주석 추가
• File -> 파일 삭제, 이름 변경
• Chore -> 잡것 (빌드 변경 등 잡다한 사항)

Header: 제목 이름
- 디테일한 사항들은
- 이렇게 추가해요

브랜치 전략

GitHub Flow, Git Flow 중에서 고민을 하였다. 각 전략에 따라서 장단점들이 존재하는 것을 확인하였다.

Git Flow => Feature, Release, HotFix 등의 브랜치가 명확히 구분되어 협업과 릴리즈 관리에 용이. 브랜치가 많아서 관리가 어려움. Github Flow => Main 브랜치와 PR 중심으로 간단하게 작업. 브랜치 작업 완료 후 즉시 Main 브랜치로 병합 및 배포 가능

Github Flow를 base로 Git Flow의 기능을 일부 사용하기로 결정하였다.

• main : 배포가 가능할 정도로 리뷰된 코드 & 앞으로의 추가 개발의 base가 될 수 있는 코드
• dev : 개발 중인 branch, feature의 merge 대상
• feature : 기능 단위의 branch

브랜치 관리는 다음과 같이 진행하기로 하였다. 작업 진행 -> dev pull -> push -> pr - dev

pr 날릴 때, pull 할 때 모두 rebase를 사용하여 로그 그래프를 1줄로 컴팩트하게 관리하기로 결정하였다.

PR Convention

1. main브랜치는 직접 push가 불가능 하도록 설정.

2. PR요청시 반드시 모든 팀원이 approve해야 병합이 가능하도록 설정.

3. PR시 반드시 리뷰 원하는 부분에 코멘트 작성.

4. 하나의 PR에 다른 팀원 모두가 각각 적어도 1개 이상의 코멘트 작성.

5. 코멘트는 반드시 1개 이상의 칭찬을 포함하기.

6. PR 병합시 graph 히스토리를 선형으로 관리하기 위해 옵션을 Rebase로 지정하기.

7. 병합이 완료된 branch는 Remote Repository에서 삭제하기.

8. PR 네이밍은 다음과 같이 작성. [{task_name}/#{issue_number}] 끝마친 작업 나열

[Login/#2] 로그인 api 연결 

이후 추가할 내용이 있으면 추가

Issue Convention

1. 작업 진행시 Issue 선택 후 내부의 Create Branch를 통해 연동된 Branch생성 후 작업 진행하기.

• 작업 완료 후 branch삭제 시 Issue가 자동으로 닫히도록 하기 위함.

2. commit시 작업 내용과 연관된 Issue번호를 마지막에 적어주기 #{issue_number}

• 다른 Issue의 작업을 진행할 경우에는 해당 Issue번호를 함께 적기 ex) 버그 해결과 같은 작업

문서화 규칙

• 완료한 기능 명세
• 고민사항

Wiki와 Notion에 모두 정리

노션에 모두 흩뿌려놓고 Wiki에 정리해서 올려놓는 것이 좋다고 생각

프로젝트를 하면서 기술을 어떻게 사용했는지

어떤 기획으로 어떤 회의를 했는지

우리는 어떤 고민을 했고, 어떤 식으로 협업을 했다.

기술적인 설정 근거와 협업 방식

면접관들에게 어떤 것을 보여주고 싶은지를 생각하고 그런 것들을 작성한다.