Skip to content

Latest commit

 

History

History
216 lines (187 loc) · 10.9 KB

README.md

File metadata and controls

216 lines (187 loc) · 10.9 KB

리포지토리 소개

oz_02_main-003-BE는 OZ 코딩 스쿨에서 진행되는 메인 프로젝트 과정에 참여중인 냉파(3팀)의 백엔드 리포지토리 입니다.

📖 프로젝트 소개

🥘 냉장고 뚝딱이

냉장고속 재료로 만들 수 있는 레시피 공유 플랫폼

🤷‍♂️ 냉장고에 재료는 많은데 뭐 해먹지?
🔖 그럴줄 알고 준비했어! 너를 위한 맞춤 레시피!
🍆 냉장고속 재료를 선택하고
🥑 레시피를 검색해봐~
🥕 너가 가진 재료들로 만들 수 있는 레시피를 알려줄게!

🙆‍♀️ 내가 찾던 레시피! 자랑하고 싶은 레시피! 냉장고 뚝딱이!

🔗 링크

💻 FE Repository

🗣️ 프로젝트 발표 영상 & 발표 문서

🗓️ 2024.05.24 - 2024.06.21

📺 발표 영상 추후 공개

🧰 사용 스택

BE




협업

👥 팀 동료

FE


@woic-ej
@backdfb
@jjaeho0415
최은진(팀장) 김효중 정재호

BE


@newbission
@suwon9729
@KangJeongHo1
@sub-blind
윤준명(팀장) 강수원 강정호 김재섭

📑 프로젝트 규칙

Branch Strategy

  • main / dev / docs 브랜치 기본 생성
  • main과 dev로 직접 push 제한
  • README, gitignore 같은 문서파일 docs로 push
  • PR 전 최소 2인 이상 승인 필수

Progress

1. CLONE

팀 리포지토리를 각자의 로컬로 클론

# 1. 백엔드 팀의 깃허브 리포지토리 클론
# 1-1. ❗️주의❗️ 'develop' 브랜치를 클론해야함
git clone -b develop "팀 깃허브 리포지토리 주소"

# 클론이 생각대로 잘 되었는지 확인
# remote의 이름이 'origin'인지, branch가 'devlop'인지 확인
$ git remote -v
> origin	https://github.com/newbission/리포지토리이름.git (fetch)
> origin	https://github.com/newbission/리포지토리이름.git (push)

$ git branch
> * develop
> (END)

2. PULL

현재까지 진행된 내용을 원격 저장소에서 로컬로 가져오기

# 현재 브랜치가 'develop'인지 확인하고 아니면 'develop'으로 브랜치 변경
$ git branch
> develop
> *feat-yjm-github-setting-#1
> (END)
$ git switch develop

# 팀 리포지토리의 `develop`브랜치의 최신 내용을 `PULL`
$ git pull origin develop

브랜치 생성

개발할 내용에 맞게 브랜치 생성

# 1. 현재 브랜치가 `develop`인지 확인
$ git branch
> * develop

# 브랜치 생성
# git branch {타입}-{개발자}-{개발}-{내용}-{이슈번호}
# git checkout -b {타입}-{개발자}-{개발}-{내용}-{이슈번호}
$ git branch feat-yjm-github-setting-#1
$ git switch feat-yjm-github-setting-#1

or

$ git checkout -b feat-yjm-github-setting-#1

PUSH 및 브랜치 제거

작업내용을 PUSH 후 PR한 뒤 브랜치 제거

# 1. 작업내용 'PUSH' 하기
$ git add .
# 1-1. git commit -m "{타입}: {커밋 내용} ({이슈번호})"
$ git commit -m "Feat: github setting complete (#1)"
$ git push origin feat-yjm-github-setting-#1


# 2. PR이 완료되어 병합이 되면 사용한 branch 삭제
# ❗️주의❗️ 병합이 되기 전에 삭제하지 말것
$ git switch develop # 반드시 삭제하려는 브랜치에서 나와야함

# 2-1. 로컬 브랜치 삭제: 'D' 옵션 사용
# git branch -D {브랜치명}
$ git branch -D feat-yjm-github-setting-#1

# 2-2. 원격 저장소(팀 리포지토리) 브랜치 삭제: 'd' 옵션 사용
# git push -d origin {브랜치명}
$ git push -d origin feat-yjm-github-setting-#1

Git Convention

  1. 적절한 커밋 접두사 작성
  2. 커밋 메시지 내용 작성
  3. 내용 뒤에 이슈 (#이슈 번호)와 같이 작성하여 이슈 연결
접두사 설명
Feat : 새로운 기능 구현
Add : 에셋 파일 추가
Fix : 버그 수정
Docs : 문서 추가 및 수정
Style : 스타일링 작업
Refactor : 코드 리팩토링 (동작 변경 없음)
Test : 테스트
Deploy : 배포
Conf : 빌드, 환경 설정
Chore : 기타 작업 
$ git commit -m "Feat: 로그인 API 개발 완료 (#이슈번호)"

Pull Request

Title

  • 제목은 '[Feat] 홈 페이지 구현'과 같이 작성합니다.

PR Type

  • FEAT: 새로운 기능 구현
  • ADD : 에셋 파일 추가
  • FIX: 버그 수정
  • DOCS: 문서 추가 및 수정
  • STYLE: 포맷팅 변경
  • REFACTOR: 코드 리팩토링
  • TEST: 테스트 관련
  • DEPLOY: 배포 관련
  • CONF: 빌드, 환경 설정
  • CHORE: 기타 작업

Description

  • 구체적인 작업 내용을 작성해주세요.
  • 이미지를 별도로 첨부하면 더 좋습니다 👍

Discussion

  • 추후 논의할 점에 대해 작성해주세요.

Code Convention

  • 최대한 PEP8 참고
  • 패키지명 전체 소문자
  • 클래스명, 인터페이스명 CamelCase
  • 클래스 이름 명사 사용
  • 상수명 SNAKE_CASE
  • Controller, Service, Dto, Repository, mapper 앞에 접미사로 통일(ex. MemberController)
  • service 계층 메서드명 create, update, find, delete로 CRUD 통일(ex. createMember)
  • Test 클래스는 접미사로 Test 사용(ex. memberFindTest)

Communication Rules

  • ZEP, Discord 활용
  • 매주 월요일 주가 스프린트
  • 매일 오정 10:30 데일리 스크럼
  • 매주 금요일 주간 회고