Skip to content

개발 규칙

Jump to bottom
bluenight12 edited this page Aug 7, 2020 · 2 revisions

코딩 컨벤션

Server

메서드명

  • 동사로 시작하고 가능한 전치사를 통해 의미를 확실히 전달
  • ex) validateCommentMember X, validateCommentOfMember O

Layer

Repository

  • findBy(Long memberId) X
  • findByMemberId(Long id) O

Service

  • Create
    • save
  • Update
    • update
  • Read
    • 단일: findById, findByname
    • 복수: findMembers
  • Delete
    • delete

Controller

  • REST API 규칙에 맞게 url 리소스 주소를 명시적으로 작성한다
  • /api/members/

Client

  1. 문장의 종료 - 세미콜론(;) 사용
  2. 변수 명명 규칙 - 카멜 케이스 사용
  3. 변수 선언 - let과 const를 사용하며, var 선언 금지하고 const를 우선 선언
  4. 템플릿 문자열 사용 - ${name} 입니다.

코드 포멧팅 플러그인

Client

  • Prettier를 사용

Git 브랜치 전략

  • master branch: 완성된 제품의 브랜치
  • develop branch: 제품 개발 브랜치
  • feature branch: 기능을 개발하는 브랜치(develop에서 분기)

Git 커밋 메시지 컨벤션

  1. 제목과 본문 한 줄 띄워 분리하기
  2. 제목의 첫글자는 대문자로
  3. 제목 끝에 . 금지
  4. 기능 추가(Add), 수정(Update), 제거(Remove)의 명령조 사용

Example

Update banner image
Remove deprecated methods
Add login page
Clone this wiki locally