Team Conventions

Github 컨벤션

• 이슈를 먼저 발행하고 기능을 개발한다!
• 기능 개발을 완료할 경우 Pull Request를 보낸다.
• Pull Request에 대한 코드 리뷰 요청을 보낸다.
• Pull Request Merge는 다 같이 진행한다.

브랜치

• PREFIX-기능명
• PREFIX의 종류
  • master: 제품으로 출시될 수 있는 브랜치
  • develop: 다음 출시 버전을 개발하는 브랜치
  • feature: 기능을 개발하는 브랜치
  • fix: 버그 수정

커밋

• [#이슈번호] PREFIX: 커밋 내용
• PREFIX의 종류
  • feat: 기능 추가
  • refactor: 리팩토링
  • fix: 버그 수정
  • style: 자동정렬, 사용하지 않는 파일 제거 등
  • docs: 문서 수정

코드 컨벤션

• 캠퍼스 핵데이 Java 코딩 컨벤션를 따른다.

클린코드

• 아래와 같은 규칙을 따른다.
  • 규칙 1: 최대한 불변을 유지한다.
  • 규칙 2: else 예약어를 쓰지 않는다.
  • 규칙 3: 모든 원시값과 문자열을 포장한다.
  • 규칙 4: 한 줄에 점을 하나만 찍는다.
  • 규칙 5: 줄여쓰지 않는다(축약 금지).
  • 규칙 6: 모든 엔티티를 최대한 작게 유지한다.
  • 규칙 7: 일급 콜렉션을 쓴다.
  • 규칙 8: 한 메서드에 최대 두 단계의 들여쓰기만 한다.

테스트

• Test Coverage는 Intellij 기준 90% 이상을 유지한다.
• 모든 테스트 코드는 @DisplayName으로 테스트 설명을 명시한다.

배포

• 배포시 마다, RELEASE VERSION을 README.md에 작성한다.
  • A.B.C
  • A: 새로운 배포
  • B: 새로운 기능
  • C: PR Merge