3. Project Convention

🔸 프로젝트 컨벤션 🔸

• 처음 등장하는 annotation 주석 달기
• Config 설정에 주석 달기
• git 커밋 메시지는 [#이슈번호] 개발 내용(간략히 한글로)
• PR 시 제목은 [#이슈번호] 구현한 기능 명시적으로 작성
• Git-flow 사용
• Merge 조건
  • 2 Approve || (1 Approve && 3일 지남)
  • Request Changes 있으면 머지 불가
• 테스트 코드 작성 & 툴을 통하여 커버리지 검사
• 줄여쓰지 않습니다.
  • 과도한 축약은 코드 가독성을 저해함
  • 문맥상 중복되는 단어는 자제
• else 생략 가능하다면 생략하기
• 트러블슈팅을 겪는다면 문서화 또는 블로그 포스팅을 통해 공유하기
• PR시 작은 단위로 쪼개서 올리기
• TODO 를 정해서 스케줄 관리 및 텐션 유지
• 매주 회의 내용 정리해서 위키에 공유
• Branch 명 feature/이슈번호
• 코딩 컨벤션 : 구글 자바 스타일 적용

---

🎈 Issue clear 순서

1. 이슈의 assignee 를 자기 자신으로 할당한다.
2. develop 브랜치 기반으로 feature 브랜치를 만든다.
3. 개발완료 후 PR 올린다.
4. 리뷰 완료 후 머징한다. 그리고 이슈 close
   • 머징 후 이슈 close
   • commit message, pr message

---

💡 프로젝트 컨벤션은 https://jamie95.tistory.com/99 (객체지향 생활 체조 원칙) 을 참고하였습니다.