keodam-backend

keodam project backend repository

Git 브랜치 전략 및 커밋 컨벤션

작업 흐름

1. 각자 브랜치에서 작업 후, develop 브랜치로 pull request.
2. 모든 멤버가 동의했을 때 develop 브랜치로 머지.
3. 간단한 피처: 한 사람이 코드 리뷰 및 승인 후 develop 브랜치로 머지.
4. 한 피쳐: 두 명 이상 코드 리뷰 후 승인 및 develop 브랜치로 머지.

커밋 메시지 컨벤션

• Feat(#이슈번호) : 새로운 기능 추가.
• Fix(#이슈번호) : 버그 수정.
• Chore(#이슈번호) : 빌드 작업.
• Refactor(#이슈번호) : 코드 리팩토링 (기능 변경 없음).
• Docs(#이슈번호) : 문서 수정.

메서드 시작명 컨벤션

• 생성 : create
• 수정 : update
• 삭제 : delete
• 조회 : find

주의 사항

• @Getter, 특히 @Setter는 지양한다.
• 클래스 선언부 아래 필드가 오면 한 칸 띄우고 작성하고 그 이외의 경우에는 붙인다.
• 메서드 길이는 15줄을 넘지 않는다. (SRP)
• 블록 들여쓰기는 1단계로 제한한다.
• 블록 아래 한 칸 띄우고 작성한다.
• else를 사용하지 않는다.
• stream 사용 시 stream 뒤에 줄바꿈을 한다.
• 의미없는 줄 개행은 삭제하고, 개행에 신경써서 코드 작성한다.