[목차]
01. 프로젝트 소개
02. git branch 전략
03. 패키지 구조
04. 커밋 메세지 전략
05. 코드 스타일 컨벤션
[01. 프로젝트 소개]
악세서리 쇼핑몰(E-commerce), Restful api, spring boot, spring security
[02. git branch 전략]
master, develop, local 세가지로 구현하였습니다
master : 서비스 로직을 완성한 안정된 코드를 관리합니다(통합테스트 통과)
develop : 단위테스트를 위한 브랜치입니다
local : 개인 단위의 작업을 위한 브랜치입니다
[03. 패키지구조]
DDD(도메인 주도 설계, Domain Driven Design) 구조로 진행
선택한 이유 : 서비스 로직에 따라 분리하니 높은 응집력과 낮은 결합도로 변경과 확장에 용이하기 때문입니다.
또한 과제에서 MSA도입을 위해 패키지들을 분리하는 작업이 이루어 질 것을 예상하여 선택하게 되었습니다.
Presentation(Controller) > Application(Service, DTO, Entity 조회, 저장) > Domain(Entity) > Infra(Repository Entity구현) 구조로 나누어 위의 계층에서 아래 계층으로만 접근할 수 있도록 구조를 잡았다.
[04. 커밋 메세지 전략]
제목에는 날짜, 제목형식을 따릅니다
예 ) [2024.04.17(수) 17:00 FIX readme MD]
제목에 사용할 동사는
1) OPTIMISE : 성능 개선했을 때 사용합니다.
2) REMOVE : 코드나 파일을 삭제했을 시 기록합니다.
3) MAKE : 기능을 완료했을 때 사용합니다.
4) DOC : 주석만 수정했을 때 기록합니다
5) MERGE : 브랜치 병합했을 때 사용합니다.
본문은 제목에 대한 내용을 간결하게 적습니다.
관련 이슈도 마지막에 적어둡니다
[2024.04.17(수) 17:00 MAKE 이메일 인증에 필요한 설정 완료]
사용자 인증을 위해 SMTP 서버 연결 및 사용자 정보 추가
04. 코드스타일 컨벤션
를 기준으로 작성한다 (포스팅 참조)
restful API 설계규칙을 따른다
(포스팅 참조)
- url의 마지막에는 '/' 을 포함하지 않는다
- 언더바(_)는 사용하지 않는다. 하이픈도 리소스의 이름이 길어지면 사용한다
- URL에 행위를 넣지 않는다. 결과(명사)만 표시한다
⭐️ 행위는 HTTP 메서드로 표현할 수 있어야 한다
- URL은 소문자로 작성한다
- 파일 확장자는 URL에 포함하지 않는다
========================================
2024.04.17. 의 기록