[Spring / Project] - SNS Application 프로젝트 2일차

SNS Application 프로젝트 2일차

프로젝트 규칙

• 개발은 팀으로 이루어진 업무이기 때문에 팀원과의 프로젝트를 진행함에 있어 몇가지 규칙을 정했습니다.
  1. Code Convention
     • 코드 규칙은 구글 스타일을 따르기로 했습니다.
       https://google.github.io/styleguide/javaguide.html
  2. Git Commit Convention
     • 커밋 규칙은 보통의 규칙을 따르기로 했고, 제목 가장 앞 부분에 Gitmoji를 상황에 맞게 추가하여 사용하기로 했습니다.
       
       • feat: 새로운 기능 추가
       • fix: 버그 수정
       • docs: 문서 수정
       • style: 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
       • refactor: 코드 리펙토링
       • test: 테스트 코트, 리펙토링 테스트 코드 추가
       • chore: 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)
       • Gitmoji란
         https://gitmoji.dev/
  3.  Pull Request 요청 규칙 (2명이 Approve를 해줘야 merge할 수 있게 설정했습니다.

---

API 명세서

• 유저 API

• 관리자 API

• 댓글 API

• 게시글 API

---

ERD 명세서

• 이번 프로젝트는 연관 관계 없이 ERD를 작성해 봤습니다.
• ERD 명세서는 평소 ERD Cloud를 사용했지만 이번에는 DrawSQL을 사용해 봤습니다.
  단점이 있다면 null 값을 허용하는 표시를 데이터 타입 옆에 ?로 표시되는 부분이 아쉬웠습니다.