-
Notifications
You must be signed in to change notification settings - Fork 2
[컨벤션]
min9805 edited this page Aug 25, 2024
·
3 revisions
- 이슈 탭에 브랜치 연결 시켜놓기
- 이슈 탭에 반드시 태그 달기
- 이슈 명명 규칙
- [BE]: 작업 분류를 위해 Backend 명시
- 작업 내용을 한 눈에 알아볼 수 있는 제목 작성
- TODO 로 상세 내역 작성 후 해당 탭들 다시 이슈로 생성
- 브랜치 명명 규칙
- main: 제품 출시 브랜치
- develop: 출시를 위해 개발하는 브랜치
- feat/{기능명}: 새로운 기능 개발하는 브랜치
- refactor/{기능명}: 개발된 기능을 리팩터링하는 브랜치
- hotfix: 출시 버전에서 발생한 버그를 수정하는 브랜치
- 기능명: {이슈 번호} - {상세 기능 명}
- 커밋 메시지는 최대한 깔끔하게 제목만 작성
- 커밋 횟수 자체를 늘려 세세하게 작성
- 커밋 명명 규칙
- feat: 새로운 기능에 대한 커밋
- fix: 버그 수정에 대한 커밋
- build: 빌드 관련 파일 수정
- docs: 문서 수정에 대한 커밋
- refactor: 코드 리팩토링에 대한 커밋
- test: 테스트 코드에 대한 커밋
- chore: 그 외 수정에 대한 커밋
- {이슈 번호} : suffix 로 모든 커밋 뒤에 괄호 내 작성
- issue를 먼저 쓴 후 pull request 보내기
- Squash and Merge 사용
- 코드 스타일
- 구글 자바 스타일 가이드를 따른다.
- builder 패턴 사용하기
- 디렉토리
- 디렉토리 명은 소문자로
- 도메인 별로 디렉토리 분리
- 엔티티
- 엔티티 변수는 primitive 타입이 아니라 wrapper type을 사용
- 설정 파일
- application.yml 파일은 노션에 관리