드디어 최종 팀프로젝트가 시작되었다. 월요일에는 조편성과 두게더(DoGetUs)라는 팀을 만들었고 팀원과 디자이너님 간의 아이스브레이킹 시간을 갖었다.화요일에는 구체적으로 어떤 제품을 만들 것인가에 대해 의논하였다. 디자이너님께서 팀회의를 정리하여 작성해주신 피그잼을 통해 주제 선정 및 아이디어 세분화, 아이디어 공유 및 방향성 확인하기, 등의 작업을 진행하였다. 그리고 오늘은 화요일에 결정된 주제와 아이디어를 조금 더 다듬었고 각자 담당할 페이지 및 기능 정리와 함께 코드 컨벤션 및 프로젝트 컨벤션, 프로젝트 셋업, 폴더구조를 작성하였다. 팀원들과 회의를 통해 내용을 정리한 뒤 부족한 부분이 있는지 튜터님들을 찾아가 자문을 구했고 깃허브 pr 템플릿이라는 것을 새롭게 알게 되었다. 오늘은 그간 회의내용 정리, 소개 및 pr템플릿에 관하여 작성하고자 한다.
1. 프로젝트 주제 및 회의 내용 정리
이번 프로젝트에서는 hotel 객실을 중개하는 애플리케이션을 개발해보고자 한다. 사이트에 접속 한 사용자는 사이트를 개발하고 관리하는 admin과, 자신의 호텔을 연결하려는 business, 사이트를 이용하여 호텔 일정을 예약하려는 user, 3분류로 나뉜다.
1) 주요 기능
- 호텔 정보 조회
- 호텔 정보 등록
- 일정 예약 및 확인
- 결제
- 문의
2) 페이지별 구성 회의 내용 정리
3) 페이지 별 기능 회의 내용 정리
2. PR 템플릿 활용하기
Github를 사용하여 프로젝트를 진행할 때 각 팀원들마다 작업한 브랜치에서 커밋한 내역을 Pull Request하고 작성한 코드를 리류하는 시간을 갖게 된다. 덕분에 코드를 merge하기 전에 변경 사항에 대해 검토하고 팀원들과 의견을 나눌 수 있다. 오늘은 튜터님들께 pr 템플릿에 대해 알게 되었고 이를 활용하면 이전보다 효과적으로 커뮤니케이션 할 수 있고, 프로젝트의 품질 또한 향상시킬 수 있다고 하셨다.
1) Github PR template 추가하기
템플릿을 추가하고 적용하는 방법은 굉장히 쉬웠다. pull_request_template.md 파일을 Base repository에 추가하면 된다고 한다.
- .github/pull_request_template.md
- docs/pull_request_template.md
- root directory 아래/pull_request_template.md
이번 프로젝트에서는 .github폴더 안에 생성하였다.
2) 템플릿 작성하기
내가 생각하기에 PR템플릿을 작성하는 이유는 이렇다. 먼저 PR요청자는 PR 요청 시 PR 템플릿을 작성함으로써 한번 더 자신이 작성한 코드를 체크할 수 있다. 다음으로는 코드리뷰 시 이를 활용하면 시간을 절약하고, 효과적으로 프로젝트의 진행도를 확인할 수 있다. 즉, 템플릿은 이런 내용이 잘 포함되도록 작성해야할 것이다.
- 🛠 PR 개요
- 해당 PR이 무엇을 하는지 간략하게 설명한다.
- 해당 PR이 무엇을 하는지 간략하게 설명한다.
- 🛠 PR 유형
- 어떤 작업을 했는지 알 수 있게 카테고리를 나눈다
어떤 변경 사항이 있나요?
- [ ] 새로운 기능 추가
- [ ] 버그 수정
- [ ] CSS 등 사용자 UI 디자인 변경
- [ ] 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
- [ ] 코드 리팩토링
- [ ] 주석 추가 및 수정
- [ ] 문서 수정
- [ ] 테스트 추가, 테스트 리팩토링
- [ ] 빌드 부분 혹은 패키지 매니저 수정
- [ ] 파일 혹은 폴더명 수정
- [ ] 파일 혹은 폴더 삭제
- 📸 이미지 첨부
- 검색해보니 어떤 작업 내용만 적으면 직관적이지 않기 때문에 화면이 변경되었다면 어떻게 수정되었는지를 사진을 첨부한다.
- 이는 필수사항은 아닌 선택사항이다.
- 💬 공유사항
- 팀원들이 PR 확인 시 중점적으로 봐주었으면 좋겠는 부분을 기재한다.
- 또는 어떤 부분에서 문제가 생겼거나 논의해야할 부분에 대해 기재한다.
- ex) OO기능 구현 부분에서 조금 더 최적화할 수 있는 방법이 있을까요?
- ✅ PR 체크리스트
- PR이 다음 요구 사항을 충족하는지 확인한다.
- [ ] 커밋 메시지 컨벤션에 맞게 작성했습니다.
- [ ] 변경 사항에 대한 테스트를 했습니다.(버그 수정/기능에 대한 테스트).
처음으로 사용해본 이 PR 템플릿이 우리 팀이 프로젝트 개발 과정에서 어떤 부분에 대해 얼마나 치밀하게 고민하였고, 팀활동을 얼마나 활발하고 적극적으로 하였는지 보여줄 수 있는 긍정적인 지표가 될 수 있었으면 좋겠다.
★ 43일차 소감
최종 프로젝트 리더로 지원하는 당시 나는 팀 간의 규칙을 더불어 코드컨벤싱, 깃허브 규칙, 등 을 매우 섬세하게 정하고 가고 싶었다. 이를 통해 정말 한 명이서 작성한 코드처럼 보일 수 있도록 보여주고 싶은 욕심이 있었다. 살짝 욕심을 부린 것 같아 팀원들이 벌써 나에게 진절머리가 나지는 않았을지 걱정이다.
'TIL' 카테고리의 다른 글
12. 30. 42일차 TIL Next프로젝트 KTP회고 (1) | 2024.12.30 |
---|---|
12. 27. 41일차 TIL next 팀프로젝트 트러블슈팅 (0) | 2024.12.28 |
12. 26. 40일차 TIL next 팀프로젝트 (1) | 2024.12.27 |
12. 23. 39일차 TIL 효율적인 파일 구조와 렌더링 방식 (2) | 2024.12.24 |
12. 19. 38일차 TIL Next.js 과제_03 마무리, 커리어코칭 정리 (0) | 2024.12.19 |