Skip to content

DO-SOPT-APP3-Airbnb/Airbnb-server

Repository files navigation

👩‍👧‍👧 Our Team

🍀 최승빈 🍀 최윤한
Server Developer Server Developer
프로젝트 세팅
숙소 정보 조회 API, 숙소 이미지 조회 API
유저 이름 조회 API, 지역 이미지 조회 API
프로젝트 셋팅
전체 총괄 및 코드 리뷰

✈ API 명세서

📑 Architecture

image

📖 Directory

```
├── ServerApplication.java
├── 🗂️ user
│   ├── 🗂️ controller
│   ├── 🗂️ domain
│   ├── 🗂️ repository
│   └── 🗂️ service
├── 🗂️ common
│   ├── 🗂️ config
│   ├── 🗂️ domain
│   ├── 🗂️ dto
│   └── 🗂️ exception
│       ├── 🗂️ enums
│       └── 🗂️ model
├── 🗂️ region
│   ├── 🗂️ controller
│   ├── 🗂️ domain
│   ├── 🗂️ repository
│   └── 🗂️ service
└── 🗂️ dormitory
    ├── 🗂️ controller
    ├── 🗂️ domain
    ├── 🗂️ repository
    └── 🗂️ service

```

📋 Model Diagram

image

✉️ Commit Messge Rules

서버 들의 Git Commit Message Rules

  • 반영사항을 바로 확인할 수 있도록 작은 기능 하나라도 구현되면 커밋을 권장합니다.
  • 기능 구현이 완벽하지 않을 땐, 각자 브랜치에 커밋을 해주세요.

📌 Commit Convention

[태그] 제목의 형태

태그 이름 설명
feat 새로운 기능을 추가할 경우
fix 버그를 고친 경우
chore 짜잘한 수정
docs 문서 수정
init 초기 설정
test 테스트 코드, 리펙토링 테스트 코드 추가
rename 파일 혹은 폴더명을 수정하거나 옮기는 작업인 경우
style 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
refactor 코드 리팩토링

커밋 타입

  • 태그: 설명 형식으로 커밋 메시지를 작성합니다.
  • 태그는 영어를 쓰고 소문자로 작성합니다.

예시 >

  feat: 검색 api 추가

💻 Github mangement

Gitflow Workflow

  • Develop, Feature, Hotfix 브랜치

  • 개발(develop): 기능들의 통합 브랜치

  • 기능 단위 개발(feature): 기능 단위 브랜치

  • 버그 수정 및 갑작스런 수정(hotfix): 수정 사항 발생 시 브랜치

  • 개발 브랜치 아래 기능별 브랜치를 만들어 작성합니다.

❗️ branch naming convention

  • develop
  • feature/issue_number
  • release/version_number
  • hotfix/issue_number

📋 Code Review Convention

  • P1: 꼭 반영해주세요 (Request changes)
  • P2: 적극적으로 고려해주세요 (Request changes)
  • P3: 웬만하면 반영해 주세요 (Comment)
  • P4: 반영해도 좋고 넘어가도 좋습니다 (Approve)
  • P5: 그냥 사소한 의견입니다 (Approve)

✍🏻 Code Convention

에어비앤비 코드 컨벤션

📍 Gitflow 규칙

  • Develop에 직접적인 commit, push는 금지합니다.
  • 커밋 메세지는 다른 사람들이 봐도 이해할 수 있게 써주세요.
  • 작업 이전에 issue 작성 후 pullrequest 와 issue를 연동해 주세요.
  • 풀리퀘스트를 통해 코드 리뷰를 전원이 코드리뷰를 진행합니다.
  • 기능 개발 시 개발 브랜치에서 feature/기능 으로 브랜치를 파서 관리합니다.
  • feature 자세한 기능 한 가지를 담당하며, 기능 개발이 완료되면 각자의 브랜치로 Pull Request를 보냅니다.
  • 각자가 기간 동안 맡은 역할을 전부 수행하면, 각자 브랜치에서 develop브랜치로 Pull Request를 보냅니다.
    develop 브랜치로의 Pull Request는 상대방의 코드리뷰 후에 merge할 수 있습니다.

About

SOPT 33기 합동세미나 Airbnb server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages