🐣 moabam backend

프로젝트 초기 세팅방법

checkstyle

1. Settings → Editor → Code Style → 점 3개 → import style → import scheme → IntelliJ code style XML → 여기에서 프로젝트 경로 /config/naver-intellij-formatter-custom.xml 선택

2. Settings → Tools → Actions on Save → Reformat code 체크

   • 이슈 : 저장해도 리포맷 안되는 경우 있음. 그럴때는 빈줄에 엔터 한번 치고 저장하고 지우고 다시 저장하면 먹힘

3. Settings → Editor → General → Auto Import → 가운데 2개 import fly 체크

4. Settings → Plugins → Marketplace에서 CheckStyle-Idea 설치

   • Settings → Tools → Checkstyle에서 Configuration File에 파란색 플러스 모양 클릭
   • 이름 : naver-custom-checkstyle 입력하고 Use a Local File에서 프로젝트 경로/config/checkstyle/checkstyle.xml 클릭
   • Next 누르고 suppression value 밑에 빈칸 더블클릭하고 config/checkstyle/suppressions.xml 입력 이후 finsh
   • 생성된거 체크 눌러서 활성화시키고 Apply
   • 좌측 중하단 쯤에 연필모양 생김 그거 클릭하면 우리가 설정한 chechkstyle에서 위배되는거 확인 가능해짐
   • 혹은 노란색 밑줄 그어지는거에 마우스 올려보면 어떤 부분에서 경고 뜨는지 확인 가능

이렇게하면 저장했을때 웬만한건 컨벤션에 맞게 수정되는데 .. enum 밑에 공백은 안되는거같음 그건 노란줄 띄워주면 일일이 수정 부탁 ^0^ 앞으로 커밋 푸쉬 전 무조~건 gradle에서 clean 하고 build 해보셈 실패한다고 놀라지 마셈 컨벤션 틀린거는 뜸 ㅋㅋ

config 파일 관리

최초 clone 하는 경우

• git clone https://github.com/team-moabam/moabam-BE.git
• git submodule init
• git submodule update

config 파일 업데이트 된 경우

• git submodule update --merge --remote

주의사항

• 평상시

  • config 파일은 커밋 체크에서 무조건 빼자. (수정한 본인이 아니면)
  • 혹시 까먹고 커밋을 했다면, 어차피 PR 못하게 버튼 사라지니까 취소하고 그 커밋 삭제해야함

• 반드시 바뀐 config를 적용해야 하는 상황 (예시, s3 버킷 주소 변경)

  • config 수정한 사람이 빠르게 dev에 push 해주기
  • feat에서 작업중인 사람은 feat 전부 stash에 넣고, dev를 pull 받고 feat에 merge 시키고 pop stash

ex) 예시상황

A가 config 파일 수정했슴

• 모든 팀원은 git submodule update --merge --remote 하기