Open chanhocode opened 6 months ago
7가지 규칙
- 제목과 본문을 한 줄 띄어 구분
- 제목은 50자 이내
- 제목 첫 글자는 대문자
- 제목 끝에 마침표 X
- 제목은 명령문으로, 과거형 X
- 본문의 각 행은 72자 이내 (줄바꿈 사용)
- 본문은 어떻게 보다 무엇을, 왜에 대하여 설명
커밋 메시지 구조
type(옵션): [#issueNumber-]Subject // 제목
body(옵션) // 본문
footer(옵션) // 꼬리말
> ## Type
Update: 리드미나 참조 파일 수정
Write: 작성
Delete: 삭제
Feat: 기능 추가
Modify: 기능 수정
Fix: 버그 수정, 오류 수정
Remove: 기능 제거
Merge: 코드 병합 (문서도)
Rename: 파일 및 폴더 수정
>## Subject
ex) Feat: Add login api
# 브랜치 전략
develop_작업내용
팀원들에게 작업 내용 메신저를 통해 공유 및 확인을 받으면 main에 병합
프론트엔드
- React 18.0.2 (최신버전)
- 카카오맵 api
- 리덕스 툴킷
- immer
- ant design
- axios
- styled-components
백엔드
리소스에 대한 명명 시
컬렉션은 복수 명사
를 사용하고, 단일 항목은 단수 명사를 사용하는 것을 권장합니다. 해당 ERD에서 USER 테이블을 살펴보면 'user/{user_id}' 형식으로 작성되어 있는 부분을users/{user_id}
형식으로 수정하면 좋을 것 같습니다.
REST API에서 로그인을 할 때 'GET' 메소드를 사용하면 보안과 관련된 문제가 발생할 수 있어
POST
메소드로 수정이 필요합니다.
이러한, 문제들로 인해 로그인과 같은 인증 관련 작업에는 대체로 'POST' 메소드가 사용되며, 이는 사용자의 정보를 HTTP요청(body)안에 숨겨서 보낼 수 있어서 더 안전합니다.
렌딩 페이지의 경우 '/hospital/main' 과 같은 구조 보다는 랜딩시 바로 나타날 수 있도록 '/' 같은 구조로 명시하도록 수정 필요 합니다.
병명은 따로 테이블로 나누어 주세요. 병명의 경우 예약시 사용자의 진료 항목에 대한 참조 용도로 사용합니다. 회원테이블에 고정되어 있는경우 매번 수정을 하게 되어 기록이 남지 못하게 되는 문제가 발생합니다.
공지 테이블에서 휴무일을 따로 관리 해주세요. 공지테이블의 공지는 단순 공지로 이용될 계획이며, 휴무일은 클라이언트쪽에서 지정해서 추가 제거 동작을 수행하게 됩니다.
- 현재 해당 주에 대한 휴무만을 지정할 수 있게 되어 있어 클라이언트 쪽에서도 'datePicker'를 통한 날짜 지정을 할 수 있도록 수정이 필요
- 날짜와 함께 타이틀 도 함께 제공할 수 있도록 수정이 필요합니다. 즉, 공지사항에서는 해당 공지만 제공하게 되고 휴무일은 따로 관리 하게 됩니다.
- 공지 사항 추가에서 "0000-00-00 내부 공사로 인한 휴무" "... (내용) 감사합니다..." 와 같은 공지 게시글을 작성할 수 있지만 휴무일을 해당 페이지에서 지정하지 않습니다.
- 휴무일 테이블의 경우 기본적으로, 타이틀 과 휴무 날짜를 포함해야합니다.
- 기본 휴무일 에 대한 테이블이 필요합니다.
- 즉, 휴무일에 대한 테이블이 두 개 필요할 수 있습니다.
API
ERD
웹페이지 레이아웃
web_layout.pdf 작성: @two678