협업하며 맞춰본 자그마한 컨벤션 모음 zip

눈덩이 기술부채

코드를 구현하다 보면 정말 말도안되게 작은 일인데 정하지 않고 넘어가면 피곤한 눈엣가시같은 규칙들이 있다..

프로젝트의 규모는 점점 커지는데.. 이런 것들을 눈감고 지나가니.. 눈덩이처럼 불어나기 때문에 단판을 지어야 한다!

같이 개발하며 맞추면 좋은 사소한 것들을 경험을 기반해 설명하고자 한다. 

 

---

 

1. git commit 과 & PR 컨벤션

git convention

git commit 시 유명한 prefix가 몇가지 있어서 알아서 사용하는 느낌이었다.

표준 prefix에서 팀이 사용할 몇가지만 명시하고, commit 정책을 디테일한 예시와 함께 정리했다.

feature	새로운 기능에 대한 commit
fix	수정에 관한 commit
style	코드 스타일에 관한 commit
refactor	코드 리팩토링에 대한 commit
test	test code 작업 및 수정에 대한 commit

[type] : 커밋 제목 # Issue No.
// 띄어쓰기 하단 생략 가능
- 내용
- 내용

기존 Issue No. 기준으로 하던 commit 제목을 행위 prefix로 변경하여 한눈에 commit의도를 알아보게끔 하고
상세 내용은 띄어쓰기 후 작성해 log tree로 깔끔히 확인 가능하도록 팀원들과 협의했다.

 

 

PR 정책

개발 부서전체 공동으로사용하는 PR 정책이 있었으나, QA가 부분적으로 묶여 진행되는 점, 그로 인한 QA분기 처리가 어려움 등으로 인해 팀만의 브랜치 정책을 만들고 PR을 진행했다.

 

🙋‍♀️PR → 🙋‍♂️ 🙋 코드리뷰 → 💁‍♀️ 대응 → 🙆‍♂️ 🙆 동의 → 🙆‍♀️ merge

 

진행하는 프로젝트에 대한 코드리뷰 가이드가 따로 없어 구두로 설명, 승인 후 merge하는 경우가 잦았다.

이러한 습관은 코드 리뷰 적체와 휴먼 에러 증가 증폭기었다.

 

따라서 나름의 규칙을 만들어 실행해보자 제안했는데 너무 감사하게도 팀원 모두가 좋아하고 이해하는 규칙이 되었다.

사실 간단한거지만 명시해놓으니 더 신경쓰게 되었다.

• 프로젝트 진행 인원은 PR code review를 진행 권고
• PR 당사자는 code review 시 대응 개선 작업 후 merge 가능
• PR 전 반드시 master을 Pull하는 최신화 작업 필수
• 프로젝트 진행자 50% 의 approve 를 통해서 머지 가능

 

 

2. 문제점 & 개선공유 Board 만들기

코드를 바쁘게 구현하며 자꾸만 작은 문제들이 쌓이기 시작했다. 처음엔  사소했지만 문제는 차차 쌓이고 잊혀졌다.

잊혀지는 문제들의 특징을 보니

• 전체 구조적인 변경이 필요한 경우
• 혹은 아주 사소해서 잊어버리는 경우
• 상호간의 협의가 필요한 경우

결론적으로 사소하거나, 전체적이거나 , 협의가 필요한거나 한 문제를  한 데 모을 공간이 필요했다!

이를 중앙집중적으로 관리하고 현행화 하기 위해 우리만의 Board를 만들고 규칙을 만들었다.

 

 

Board는 프로젝트 참여인원이 rotation으로 관리하기로 하며

1주마다 바뀌는 이유 = 참여 인원 모두 프로젝트 전반에 대한 이해를 높이기 위해 반복성을 부여한 것이다.

 

 

 

 

 

 

나름 큰 체크리스트를 만든 것과 같았는데 

리팩토링, 구조 변경, 공통화, 협업  등  tag를 만들어 비용을 선정하고 주기적으로 팀원들이 task를 가져가 처리하고 완료하는 방식을 선정했다.

 

 

 

 

3.  디자인 시스템 공유

디자인 시스템을 공유하게 된 계기는 팀 특성상 프로젝트 In -Out이 주기적으로 일어났는데,

그 때마다 코드의 대격동이 일어났거나, 나름의 규칙이 생겨있었는데 그걸 리뷰를 통해 일일히 전달하는 것 또한 일이라고 생각했고,

이러한 정보또한 주기적으로 관리되어야 한다고 판단했다.

 

잘 관리되고 공유되었으면 하는 내용 4가지 정도를 뽑아 공유하기로 결심했다! 

 

- 디렉토리 구조

- 라우트 구조

- API 통신과 hook

- Type 정의

 

이 문서를 보고 프로젝트의 구조 전반을 이해해 결국 코드 파악의 신속성을 높일 수 있을 것 같았고, 

무엇보다 이러한 팀의 고민과 흔적이 남기를 바랬다.❤️

 

 

 

---

 

🥳 배우고 느낀 점

처음 이런 것들을 제안하기까지 어느정도 고민이 있었다.

팀의 사정과 히스토리를 정확히 몰랐고, 이런 자료를 생성하고 공유하는 것 또한 리소스 투입이기 때문이다.

하지만, 이런 것들을 망설이는게 옳은가? 하면 아니라는 결론이 확실했기에!! 꾸준히 두드려 보는게 중요하다.

팀에서도 이런 문화와 정리가 만들어짐을 바랬지만 일이바빠서, 운영이슈 마감 등의 이유로 나서지 못한 것이라는 예측이 든다.

그러므로 나는 오늘도 다짐한다. 나의 역할을 해야지, 열심히 이 태도를 유지해야지!