Skip to content

CNU-Software-Academy/cheerdo-server

Repository files navigation

cheerdo-server

cheerdo server repo

Version

  • spring boot 2.7.7 ( spring 5 )
  • Jdk-17 ( Java 17 )

Ground Rule

Commit Convention

  • the AngulatJS commit convention (type)(scope): (message)

(type)에 들어갈 수 있는 양식

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서 관련
style : 스타일 변경 (포매팅 수정, 들여쓰기 추가, …)
refactor : 코드 리팩토링
test : 테스트 관련 코드
build : 빌드 관련 파일 수정
ci : CI 설정 파일 수정
perf : 성능 개선
chore : 그 외 자잘한 수정

(scope)는 각자 맡고 있는 domain을 적음

ex) member, main, freinds, post

소문자로 메시지를 통일함.

ex) feat(main): make request validation

reference: https://velog.io/@outstandingboy/Git-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%EA%B7%9C%EC%95%BD-%EC%A0%95%EB%A6%AC-the-AngularJS-commit-conventions

Code Convention

  • google Java Style Guide

InteliJ에 있는 Reformat Code 기능을 수시로 할 것

reference: https://google.github.io/styleguide/javaguide.html

Constructor Pattern

  • Builder Pattern 을 사용

reference: https://velog.io/@yje876/Spring-Boot-%EB%B9%8C%EB%8D%94Builder-%ED%8C%A8%ED%84%B4-%EB%B0%8F-%EB%8B%A8%EC%9C%84-%ED%85%8C%EC%8A%A4%ED%8A%B8