Convention

🙏 Convention

Code Convention

• indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다.
  • 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
  • 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메서드)를 분리하면 된다.
• 3항 연산자를 쓰지 않는다.
• 함수(또는 메서드)가 한 가지 일만 하도록 최대한 작게 만들어라.
• 클래스 선언부와 필드 사이에 공백 하나 추가한다.
• 어노테이션은 클래스 혹은 메소드와 가장 관련된 것을 선언부와 가깝게 작성한다.
• 주석은 코드 로직이 복잡할 때에 작성
• 비즈니스 코드는 카멜 케이스
• 도메인 코드에 setter, 롬복 @Data 금지 (dto 예외)
• Stream API 사용

Commit Message Convention

feat: 새로운 기능 추가
fix: 버그 수정
docs: 문서 관련
style: 스타일 변경 (포매팅 수정, 들여쓰기 추가, …)
refactor: 코드 리팩토링
test: 테스트 관련 코드
build: 빌드 관련 파일 수정
ci: CI 설정 파일 수정
perf: 성능 개선
chore: 그 외 자잘한 수정
remove: 파일을 삭제하는 작업만 수행한 경우
breaking change: 커다란 api 변경

Merge Commit Message Convention

feature > dev merge 시 발생하는 커밋 메시지 컨벤션

1. squash and merge
2. 커밋 메시지는 prefix: {작업 내용} (#PR번호)
3. 메시지 바디에는 커밋 내역

ex.