[논의] 개발팀 개발 시작 전, 논의사항

팀에서 개발을 진행하려면, 효율적으로 코딩하고 관리할 필요가 있다는 사실을 느낍니다.

그리하여 그에 따라 진행하고 있는 방식을 간단하게 정리해보았습니다.

 

우선, 서로에 대해 아는 사항이 전혀 없다면 간단하게 아래 내용을 말하면서 개발 환경을 통일하는게 우선시 되어야겠지요.

 

어떤 기술 스택을 가지고 있는지
협업툴과 개발툴은 어떤 것을 사용해 봤는지

 

---

 

코딩 컨벤션

저는 잘 몰랐지만, 이렇게 논의하여 미리 통일시켜두는 방식이자 규칙을 코딩 컨벤션이라고 합니다.

코딩 컨벤션은 코드 개발자가 누구인지 상관없이 일관성을 유지하며, 불필요한 논쟁을 줄일 수 있게 됩니다!

 

변수명 (아래의 사항들을 캐멀 or 언더스코어 + 소문자(대문자) 중 고르면 됩니다.

• 자바 : 캐멀 표기법 (userNickname)
• DB
  • 테이블명 : 대문자 + 언더스코어 표기법 (USER_BOARD)
  • 칼럼명 : 소문자 + 언더스코어 표기법 (user_nickname)

 

로그 관리

• error, info, debug, treace, warn 등

 

예외처리

• 메서드 마다 try-catch
• aop
• @globaladvice, @exceptionHandler 등
• exception 코드 따로 관리

 

운영환경(역할)

• 운영 : 로드밸런싱(예비용 ec2)
• 개발 ↔ 운영 환경 ↔ local : 다 다른 환경

 

공유 주기

• 중간 점검 횟수 & 날짜
• 커밋, 푸시 언제 할지

---

Github 관리

아래는 헤이딜러에서 진행하고 있는 방식입니다. 저희 팀도 이렇게 진행하면, 좋을 것 같네요!

 

코딩 규칙 정하기
Branch와 커밋이름에 이슈번호 prefix로 적기
PR과 커밋은 최대한 작은 단위로 쪼개기
GitHub 템플릿으로 PR내용 규격화
라벨 활용하기
리뷰어가 빌드 성공여부/코딩컨벤션 확인하지 않기
코드리뷰 내용 반영할때마다 커밋 id남기기

 

여러분이 보시기에는 어떤가요?
아직 많이 부족해보이지만, 하나씩 부족한 부분을 채워보려고 합니다.

---

참고자료 : 헤이딜러 개발팀 모두가 행복한 개발/PR관리 방법 7가지